docs: update README.md

README.md

@@ -1,5 +1,36 @@
-### Description
+# cdm-utils – Discrete Math web calculator
 
-During studying students often have to do routine work while doing hometasks, practical exercises and tests. In order to solve more complex task often you need to perform a few easy but time consuming actions. We have presented the solution to this problem in the form of a web application: a calculator in Discrete Mathematics, which includes Set algebra and Boolean algebra calculators.
+Available feature:
 
-This is our small university project. You can check github-pages deployment [here](https://cuqmbr.github.io/cdm-utils/)
+- Set calculus
+- Boolean calculus including truth tables, PDNF and PCNF
+- Setp by step calculus
+
+## Project preview
+
+<div style="display: flex;">
+  <img src="http://drive.google.com/uc?export=view&id=1tAZcarKvcVKFw90B3eLnDJpCp0zTzX4-" alt="Boolean algebra calculator page" width="480" height="233"  border="10" />
+</div>
+
+Checkout github-pages deployment [here](https://cuqmbr.github.io/cdm-utils/)
+
+## How to install?
+
+1. Clone this project
+2. Done. These are pure html pages :)
+
+## How to contribute?
+
+If you want to add a feature, you should follow these steps:
+
+1. Fork the project
+2. Make some changes and commit them with [conventional commit message](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)
+3. Submit a PR with a new feature/code
+
+## Find a bug?
+
+If you found an issue or would like to submit an improvement to this project, please submit an issue using the issues tab above. If you would like to submit a PR with a fix, reference the issue you created!
+
+## Known issues (Work in progress)
+
+Unknown or forgiven