rewrite readme

README.md

@@ -1,14 +1,27 @@
-# OpenPokerTools Website
+<h1>
+    <img style="position: relative; bottom: -10px;" width="50" src="https://raw.githubusercontent.com/openpokertools/openpokertools.com/main/src/static/logo.png">
+    OpenPokerTools.com
+</h1>
 
-## BUGS
-* Loading bug (fixed ish by reseting on NaN)
-* Add graph to show equity progression over deal
+![build](https://github.com/openpokertools/openpokertools.com/actions/workflows/deploy.yml/badge.svg)
 
+The goal of this project is to provide a set of free and open source poker tools, which can be easily accessed on the web without needing to install any software on your device.
 
-range_equity.html
----
-* collapse range if cards are selected
-* clear errors on simulate (maybe)?
-* Should stop simulator after short time (people dislike running forever?)
-    * Set fixed number of simulations. Display that number with optional plus minus.
-* It is not clear that cards replaces range or vice versa
+To use the tools simply go to [https://openpokertools.com/](https://openpokertools.com/).
+
+## Build
+
+Follow these steps to build the website on your machine.
+1. [Install node](https://nodejs.org/en/download)
+2. `npm install`
+3. `npm run build`
+4. Go to the newly created folder `dist`
+5. Open the `dist/index.html` file in your browser
+
+## Contributing
+
+If you experience a bug or wish to see a feature added please [open an issue](https://github.com/openpokertools/openpokertools.com/issues). However if you feel up to the challenge, contributions in the form of [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) are welcome and much appreciated.
+
+## License
+
+[AGPL-3.0](LICENSE)