Merge pull request #2 from shivang0-0/main

README updated

Author: shivang0-0

README.md

@@ -1,3 +1,30 @@
 # AttendX
 
 QR based attendance solution for offline events.
+## Contributing
+
+Contributions are always welcome!
+
+- Create a fork of the project.
+
+- Clone the project using `git clone https://url-to-your-local-fork`.
+
+- Navigate to the project directory `cd AttendX`.
+
+There you go! Make awesome changes and contribute by making a Pull Request. Make sure to properly document the changes/addition you're trying to bring in AttendX.
+
+
+## Run Locally
+
+- Follow the steps to setup flutter in your system from [official guide](https://flutter-ko.dev/get-started/install).
+
+- Make sure that `flutter doctor` throws no error/warnings after installation.
+
+- Navigate to the project directory, and execute `flutter run`, this will prompt you to select the platform.
+
+![flutter-run-output](https://0x0.st/HhAY.png)
+
+- Choose one from the list, or connect your Android phone via cable, and turn on USB Debugging from the Developers Option to use your device for hot reload.
+## Installation
+
+Do check the releases, we'll drop a binary very soon.