Move example to examples dir.

grempe · May 13, 2016 · f15580c · f15580c
1 parent badfb70
commit f15580c
Show file tree

Hide file tree

Showing 10 changed files with 5 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,5 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/example/.bundle/
-/example/Gemfile.lock
+/examples/.bundle/
+/examples/Gemfile.lock
diff --git a/README.md b/README.md
@@ -25,22 +25,10 @@ compliant third-party libraries:
 
 [JSRP / JavaScript](https://github.com/alax/jsrp)
 
-Currently supported for SHA1 hash which is not the default. You can configure
-JSRP to use SHA1 using the following config directive:
-
-```js
-client.init({ username: username, password: password, length: 2048 }, function () {
-
-  client.srp.params.hash = 'sha1'
-
-  ...
-})
-```
-
 ## Usage Example
 
 In this example the client and server steps are interleaved for demonstration
-purposes. See the `example` dir for simple working client and server
+purposes. See the `examples` dir for simple working client and server
 implementations.
 
 ``` ruby
@@ -104,7 +92,7 @@ client.verify(server_H_AMK) == true
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,
-run `rake test` to run the tests. You can also run `bin/console` for an
+run `bundle exec rake test` to run the tests. You can also run `bin/console` for an
 interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
diff --git a/example/Gemfile → examples/Gemfile b/example/Gemfile → examples/Gemfile
diff --git a/example/README.md → examples/README.md b/example/README.md → examples/README.md
@@ -3,7 +3,7 @@
 ## Install Ruby Dependencies
 
 ```
-$ cd example
+$ cd examples
 $ bundle install
 ```
 

diff --git a/example/clients/javascript/.gitignore → examples/clients/javascript/.gitignore b/example/clients/javascript/.gitignore → examples/clients/javascript/.gitignore
diff --git a/example/clients/javascript/app.js → examples/clients/javascript/app.js b/example/clients/javascript/app.js → examples/clients/javascript/app.js
diff --git a/example/clients/javascript/index.html → examples/clients/javascript/index.html b/example/clients/javascript/index.html → examples/clients/javascript/index.html
diff --git a/example/clients/javascript/package.json → examples/clients/javascript/package.json b/example/clients/javascript/package.json → examples/clients/javascript/package.json
diff --git a/example/clients/ruby/client.rb → examples/clients/ruby/client.rb b/example/clients/ruby/client.rb → examples/clients/ruby/client.rb
diff --git a/example/server.rb → examples/server.rb b/example/server.rb → examples/server.rb