diff --git a/README.md b/README.md index 7a1c031..a0cdae9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ # Open Source Code Contributions -### Contributors Country Flags -Nigeria -Uganda -Kenya flag -Benin -Brazil -Tanzania flag -South Africa -Mozambican +A small project to practice making contributions and adding contributor profiles. +Quick start +- Open `index.html` in your browser, or serve the folder locally: -This is a project for you to practice contributing to open source projects with code. +```bash +python -m http.server 8000 +# then open http://localhost:8000 +``` -We're assuming that you've already finished the tutorial at [first open source contributions](https://github.com/btrust-builders/first-open-source-contributions) +Contributing +- Follow the guide in `docs/CONTRIBUTING.md` to add or update a contributor profile in the `contributors/` folder. -Head over to [contribution guide](https://github.com/btrust-builders/open-source-code-contributions/blob/main/docs/CONTRIBUTING.md) to start. +View contributors +- The site is published at: https://btrust-builders.github.io/open-source-code-contributions/ -View Contributors Here: https://btrust-builders.github.io/open-source-code-contributions/ +License +- See the `LICENSE` file for license details. + +Thanks for contributing — small improvements welcome!