Closed edwardsmoses closed 1 year ago
Here are some examples of README documentation that you could use as an example: https://github.com/MetaMask/metamask-extension#building-locally
More examples: https://github.com/darkreader/darkreader#building-for-use https://github.com/GoogleChrome/chrome-extensions-samples/blob/main/CONTRIBUTING.md#setting-up-your-environment https://github.com/refined-github/refined-github/blob/main/contributing.md#contributing https://github.com/radekmie/MiniMongoExplorer#development
Here's an example of documentation I wrote for a project:
For this Project, the Node version requirement is: Node.js 16.x or later
Also, in the documentation, add a link to this repo: https://github.com/PlasmoHQ/plasmo, as this is the framework in use for the extension.
Let me know if there're any questions - thanks!
Here's another nice example: https://github.com/PlasmoHQ/plasmo/blob/main/.github/CONTRIBUTING.md
Update the
README
file to help contributors onboard on the repo.