README.md in gollum-auth-0.1.2 vs README.md in gollum-auth-0.2.0
- old
+ new
@@ -37,22 +37,30 @@
Here is a sample `config.ru`:
```ruby
#!/usr/bin/env ruby
require 'rubygems'
-require 'gollum/auth' # Load the gem!
+require 'gollum/auth' # Don't forget to load the gem!
require 'gollum/app'
-# Enable Authentication and define users *before* running Precious::App!
-use Gollum::Auth, users: YAML.load(%q{
+# Define list of authorized users where each must have a "name", "password"
+and "email":
+users = YAML.load %q{
---
-- user: admin
- password: test
-- user: foo
- password: bar
-})
+- name: Rick Sanchez
+ password: asdf754&1129-@lUZw
+ email: rick@example.com
+- name: Morty Smith
+ password: 12345
+ email: morty@example.com
+}
+# Allow only authenticated users to access and change the wiki.
+# (NOTE: This must be loaded *before* Precious::App!)
+use Gollum::Auth, users
+
+# That's it. The rest is for gollum only.
gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO
wiki_options = {:universal_toc => false}
Precious::App.set(:gollum_path, gollum_path)
Precious::App.set(:wiki_options, wiki_options)
run Precious::App
@@ -62,15 +70,9 @@
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `rake spec` 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`.
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on the official