feat(readme): wrote important information in the readme

README.md

@@ -1 +1,40 @@
 # bi0s-pentest
+
+[![CI](https://github.com/231tr0n/bi0s-pentest/actions/workflows/main.yml/badge.svg)](https://github.com/231tr0n/bi0s-pentest/actions/workflows/main.yml)
+
+This is the source code of the bi0s-pentest website developed in sveltekit.
+
+## Helpful commands.
+
+### Run
+
+```bash
+npm run dev
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Format
+
+```bash
+npm run format
+```
+
+### Lint
+
+```bash
+npm run lint
+```
+
+### Important points to note when contributing.
+
+- Github action will fail in the following scenarios
+  1. Eslint linting error
+  2. Prettier formatting error
+  3. Build error
+  4. Commit message not following [conventional commiting format](https://conventionalcommits.org).
+- In the event of failure of the github action, go to its logs and check which job has failed and what is the error printed so that it can be debugged and resolved.