Merge pull request #45 from kunwardeep/update-readme

update readme

Author: kunwardeep

README.md

@@ -4,6 +4,12 @@
 
 The Go linter `paralleltest` checks that the t.Parallel gets called for the test method and for the range of test cases within the test.
 
+## Installation
+
+```sh
+go install github.com/kunwardeep/paralleltest@latest
+```
+
 ## Usage
 
 ```sh
@@ -16,6 +22,57 @@ A few options can be activated by flag:
 * `-ignoremissingsubtests`: Require that top-level tests specify `t.Parallel`, but don't require it in subtests (`t.Run(...)`).
 * `-ignoreloopVar`: Ignore loop variable detection.
 
+## Development
+
+### Prerequisites
+
+- Go 1.23.0 or later
+- Make
+
+### Local Development
+
+1. Clone the repository:
+```sh
+git clone https://github.com/kunwardeep/paralleltest.git
+cd paralleltest
+```
+
+2. Install development tools:
+```sh
+make install_devtools
+```
+
+3. Install dependencies:
+```sh
+make ensure_deps
+```
+
+4. Run tests:
+```sh
+make test
+```
+
+5. Run linter:
+```sh
+make lint
+```
+
+To fix linting issues automatically:
+```sh
+make lint_fix
+```
+
+### CI/CD
+
+The project uses GitHub Actions for continuous integration. The workflow includes:
+
+- Running tests with race condition detection
+- Running golangci-lint for code quality checks
+
+The workflow runs on:
+- Pull requests
+- Pushes to the main branch
+
 ## Examples
 
 ### Missing `t.Parallel()` in the test method
@@ -100,7 +157,6 @@ func TestFunctionRangeNotUsingRangeValueInTDotRun(t *testing.T) {
   }{{name: "foo"}}
   for _, tc := range testCases {
     t.Run(tc.name, func(t *testing.T) {
-      // ^ call to tc.name
       t.Parallel()
       fmt.Println(tc.name)
     })
@@ -146,3 +202,15 @@ func TestFunctionRangeNotReInitialisingVariable(t *testing.T) {
 // Error displayed
 // Range statement for test TestFunctionRangeNotReInitialisingVariable does not reinitialise the variable tc
 ```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.