Update README

README.md

@@ -1,28 +1,46 @@
-# README
+# Akkounts
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+This app allows Kosmos/LDAP users to manage their accounts, including
+credentials, invites, donations, etc..
 
-Things you may want to cover:
+## Development
 
-* Ruby version
+### Rails app
 
-* System dependencies
+Installing dependencies:
 
-* Configuration
+    bundle install
+    yarn install
 
-* Database creation
+Setting up local database (SQLite):
 
-* Database initialization
+    bundle exec rails db:create
+    bundle exec rails db:migrate
 
-* How to run the test suite
+Running the dev server:
 
-* Services (job queues, cache servers, search engines, etc.)
+    bundle exec rails server
 
-* Deployment instructions
+Running all specs:
 
-* ...
+    bundle exec rspec
+
+### LDAP server
+
+TODO make it easy to run a local Kosmos LDAP server for development, without
+manual LDIF imports etc. (or provide a staging instance)
 
 ## Documentation
 
+* [Ruby on Rails](https://guides.rubyonrails.org/)
+* [Sass](https://sass-lang.com/documentation)
+
+### Testing
+
+* [RSpec](https://rspec.info/documentation/)
+* [Capybara](https://rubydoc.info/github/teamcapybara/capybara/master)
+
+### LDAP / Auth
+
+* [devise_ldap_authenticatable](https://github.com/cschiewek/devise_ldap_authenticatable)
 * [net/ldap](https://www.rubydoc.info/gems/net-ldap/Net/LDAP)