Update README

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Centre for the Acceleration of Social Technology (CAST)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,22 +2,82 @@
 
 [![CircleCI](https://circleci.com/gh/TechforgoodCAST/beehive-giving.svg?style=svg&circle-token=9943df0487898ea0014071a42ee8da8b0d4b1d7e)](https://circleci.com/gh/TechforgoodCAST/beehive-giving)
 
-## Setup
-Prerequisites: [Ruby](https://www.ruby-lang.org), [Bundler](https://bundler.io/), [PostgreSQL](https://www.postgresql.org/), [NodeJS](https://nodejs.org/), [Yarn](https://yarnpkg.com/)
-
-1. `bundle install`
-2. `yarn`
-3. `rails db:setup`
-4. Create `.env` file with appropriate configuration:
-   ```
-   STRIPE_SECRET_KEY=<secret_key>
-   STRIPE_PUBLISHABLE_KEY=<publishable_key>
-   <!-- TODO: document stripe env vars -->
-   STRIPE_FEE_OPPORTUNITY_SEEKER=80
-   STRIPE_AMOUNT_OPPORTUNITY_SEEKER=1999
-   ```
-5. `rails s` and `bin/webpack-dev-server` to start local development servers
-
-## Running tests
-- `rspec` to run Ruby unit and feature tests.
+[Beehive](http://www.beehivegiving.org) is a free and open source funding suitability checking tool maintained by [CAST](http://wearecast.org.uk). It uses a funder’s guidelines, priorities and open data to produce a report that helps fund seekers decide where to apply.
+
+The tool has been developed with charitable grant funding in mind, but has the scope to work for other types of opportunities that non-profits may apply for with minimal changes.
+
+## Getting started
+
+These instructions will get a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+[Ruby v2.5.3](https://www.ruby-lang.org), [Bundler](https://bundler.io/), [PostgreSQL](https://www.postgresql.org/), [NodeJS](https://nodejs.org/), [Yarn](https://yarnpkg.com/), and a [Stripe](https://stripe.com) account if you'd like to process payments.
+
+### Local setup
+
+1. `git clone https://github.com/TechforgoodCAST/chc-referrals.git`
+2. `cd beehive-giving`
+3. `bundle install`
+4. `yarn install`
+5. `rails db:setup`
+6. Create `.env` file with the appropriate configuration:
+    ```env
+    STRIPE_SECRET_KEY=<your test secret key from Stripe>
+    STRIPE_PUBLISHABLE_KEY=<your test publishable key from Stripe>
+    STRIPE_FEE_OPPORTUNITY_SEEKER=<card processing fee in pence e.g. 80>
+    STRIPE_AMOUNT_OPPORTUNITY_SEEKER=<private report cost in pence e.g. 1999>
+    <!-- Optional -->
+    HASHIDS_SALT=<a secret key for encoding Hashids>
+    ```
+7. `rails s` to start local development server alongside `bin/webpack-dev-server` for JavaScript assets
+
+### Running tests
+
+- `bundle exec spring rspec` to run Ruby unit and end-to-end tests.
 - `yarn test` to run JavaScript unit tests.
+
+### Administration
+
+This project uses [Active Admin](https://activeadmin.info) to provide a simple administration interface for managing records in the database. Visit the `/admin` path with the server running to make use of it, and see Active Admin's [documentation](https://activeadmin.info/documentation.html) for more details.
+
+## Deployment
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/TechforgoodCAST/beehive-giving)
+
+## Contributing
+
+First of all, **thank you** for your help!
+
+Be sure to check out the projects open [issues](https://github.com/TechforgoodCAST/beehive-giving/issues) to see where help is needed - those labeled [good first issue](https://github.com/TechforgoodCAST/beehive-giving/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) can be a good place to start.
+
+### Bugs
+
+If you've spotted a bug please file an [issue](https://github.com/TechforgoodCAST/beehive-giving/issues) and apply the `bug` label. Even better, submit a [pull request](https://github.com/TechforgoodCAST/beehive-giving/pulls) (details below) with a patch.
+
+### Pull requests
+
+If you want a feature added the best way to get it done is to submit a pull request that implements it...
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Implement your changes
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to GitHub (`git push origin my-new-feature`)
+6. Create a [pull request](https://github.com/TechforgoodCAST/beehive-giving/compare/develop...my-new-feature) into the [develop](https://github.com/TechforgoodCAST/beehive-giving/tree/develop) branch
+
+Alternatively you can submit an [issue](https://github.com/TechforgoodCAST/beehive-giving/issues) describing the feature.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/TechforgoodCAST/beehive-giving/tags).
+
+## Authors
+
+- **Suraj Vadgama** - *Founder* - [suninthesky](https://github.com/suninthesky)
+
+See also the list of [contributors](https://github.com/TechforgoodCAST/beehive-giving/contributors) who participated in this project.
+
+## License
+
+This project is released under the MIT License - see the [LICENSE.md](LICENSE.md) for details.

app.json

@@ -0,0 +1,6 @@
+{
+  "name": "Beehive Giving",
+  "description": "A free funding suitability checking tool",
+  "repository": "https://github.com/TechforgoodCAST/beehive-giving",
+  "keywords": ["ruby", "rails", "tech-for-good"]
+}