diff --git a/README.md b/README.md new file mode 100644 index 0000000..58f9ac6 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# netxml2kml – .netxml to .kml airodump output converter + + + + + + + + + +## 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! + + + +## Development status + +Prototype – An early prototype for testing an idea out, fate of project unknown