Browse Source

Fill out README.md with useful stuff

Douglas Thrift 6 years ago
parent
commit
b59718c1e3
1 changed files with 32 additions and 1 deletions
  1. 32 1
      README.md

+ 32 - 1
README.md

@@ -1,3 +1,34 @@
 # flickrlicense
 
-A thingy to update Flickr photo licenses
+A thingy to update Flickr photo licenses
+
+## Dependencies
+
+* [Ruby]
+  * [Bundler]
+
+[Ruby]: https://www.ruby-lang.org/
+[Bundler]: https://bundler.io/
+
+## Setup
+
+Install dependencies:
+
+```bash
+bundle install
+```
+
+Copy `config.sample.yml` to `config.yml` and replace field values with a [Flickr
+API key and secret] and a generated random session secret.
+
+[Flickr API key and secret]: https://www.flickr.com/services/apps/by/me
+
+Start the server:
+
+```bash
+bundle exec rackup
+```
+
+The app should now be running at [localhost:9292] and you can login with your Flickr account.
+
+[localhost:9292]: http://localhost:9292/