Added proper README

README.md

@@ -1,2 +1,51 @@
-# asiimov
+# Asiimov
+
 A free, open source CS:GO item trading platform.
+
+## Goals
+
+- You can authenticate with your steam account
+- You can create 'offers' using your items as a base
+- A border color indicates if the item is still in your inventory
+- You can manually renew a offer page to check if the item is still in the inventory (if we knew the api key)
+- You can send trade offers (preferably with the items preselected or even completely automated)
+- You have a profile with some badges to get your profile semi verified (email, steam api key, trade link)
+- Everything is available for free (given you login with steam and provide the api key
+- Items should be displayed with: Item ID, Inspect Link, Pattern Index (...) NO PRICES! We don't want to anger Valve!
+- Simple user design, minimalistic, less pages more features
+
+Additional features and goals will be tracked in this repositories issues.
+
+## Pages
+
+- Home Page (for people who aren't signed in)
+- Overview Page (for people who are signed in, live feed of created trades)
+- `/offer/<offerID>` - Offer page (for each offer)
+- `/offer/<offerID>/refresh` - Refreshes offer page
+- `/profile/<steamID>` - Profile page for badges, confirmed trades (...)
+- `/profile/<steamID>/settings` - Personal settings
+- `/search/<filter>` - Offer Search/ Filter
+- `/create` - Create offer
+
+## Setup Testing Environment
+
+1. Clone repository
+2. Set up [virtualenv](https://virtualenv.pypa.io/en/latest/)
+3. Install dependencies with `pip install -r requirements.txt`
+4. Migrate database scheme `python manage.py migrate`
+5. Run the test server `python manage.py runserver`
+
+## Branching
+
+We use a pretty simple and intuitive branching structure:
+
+- `master` - Contains deployable code where everything is tested and tagged to the latest version
+- `dev` - Contains the latest version of seemingly stable code, pull requests will be collected and tested here
+- `hotfix-X` - Is a branch where security or major issues are worked on, they will be merged into `master` and `dev`
+- `feature-X` - Is a branch where a specific feature is worked on, will be merged into `dev`
+
+If you fork this repository, you are most likely working in the `dev` branch and creating a pull request from your `dev` to our `dev`.
+
+## Contribution Guide
+
+See the `CONTRIBUTING.md`