Add readme.md (#65)

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Inserting dank memes corresponding to the subjects of PRs and issues
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -1,9 +1,70 @@
-# aion
-E-learning platform based on multiplayer gameplay in real-time. Written in Elixir and Elm
-
-# run it
-`cd aion`
-`mix deps.get`
-`mix ecto.create && mix ecto.migrate`
-`npm install`
-`mix phoenix.server`
+![Aion](https://user-images.githubusercontent.com/15965147/28745968-d496ca7a-7483-11e7-9b59-659100df5ba8.png)
+
+
+# Aion [![Build Status](https://travis-ci.org/pmrukot/aion.svg?branch=master)](https://travis-ci.org/pmrukot/aion)
+
+An e-learning platform written in Elixir and Elm based on real-time gameplay.
+
+### Prerequisites
+
+If you want to run the project in a docker container you need to install:
+- docker
+- docker-compose
+
+If you want to run it locally:
+- elixir
+- npm
+- postgres
+- python3 (only if you want to seed the database with prepared data)
+
+### Installing
+
+You can run the project both in a docker container or locally. 
+
+To run in a docker container:
+
+```
+make && make docker-start
+``` 
+
+To run locally:
+
+```
+make development && make start-dev
+```
+
+In both cases the platform should be accessible at [localhost:4000](localhost:4000)
+
+## Running the tests
+
+To run the tests before pushing to the remote you can simply run:
+
+```
+cd aion && mix test
+```
+
+
+## Built With
+
+* [Phoenix](http://www.phoenixframework.org/) - The web framework used
+* [Elm](http://elm-lang.org/) - Used to write frontend
+
+## Contributing
+
+Check out our [CONTRIBUTING.md](CONTRIBUTING.md) 
+
+## Authors
+
+* **[Piotr Jatkowski](http://github.com/jtkpiotr)** 
+* **[Patryk Mrukot](http://github.com/pmrukot)** 
+* **[Maciej Rapacz](http://github.com/mrapacz)**
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+Initial database was provided by 5th August Witkowski High School in Kraków. One of the main goals of the project was 
+to rebuild *JPKS*, a simple system with similar functionality, which was once a source of entertainment and knowledge 
+for many High School students.