Create and Show Posts (#3)

[rbdr/dasein] / README.md

diff --git a/README.md b/README.md
index 9cd6edb1b3a1c998207c8b8487f8b302395c53ef..cda02523ab5c169e599badc0705c99c9088327ab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
 # dasein
 A social network
 
+## Configuring
+
+This project usese environment variables to work. For most cases, the
+defaults work but some sensitive info like keys must be overridden. Copy
+the file in `config/env.dist` to `.env` in the project root and override
+the values.
+
+When running with `make run`, it'll pick up these values automatically.
+If you're doing it the hard way, you'll have to source them.
+
 ## Running Locally
 
 You'll need [Docker][docker] to run the project.
@@ -17,8 +27,9 @@ way.
 
 ## Generating documentation
 
-This project uses JS Doc to generate documentation. Generate everything
-with `npm run doc`.
+This project uses JSDoc to generate documentation. Generate everything
+with `npm run document`. The documentation will be generated in the
+`doc` directory.
 
 ## Building and pushing the image
 
@@ -28,6 +39,12 @@ You can also do some other operations
 * Push and build the image with `make upload`
 * Clean the environment with `make clean`
 
+## Setting up Twitter for login
+
+1. Create an app on https://apps.twitter.com/
+2. Make sure you check "Allow this application to be used to Sign in with Twitter"
+3. Make sure you specify a callback URL (eg. http://localhost:1927/login-callback)
+
 ## Checking the code
 
 This project uses the [Hapi Style Guide][hapi-style-guide] for