# SMP - the FAIR extension

1. 🎯 **Purpose**: The FAIR extension is an open-source web browser extension that helps researchers perform FAIR metrics evaluations on research Digital Objects such as publications, datasets, or research software directly from scholarly aggregators like PURE, Google Scholar, or ResearchGate.

2. 🔄 **Version control**: The project uses Git for version control and is hosted on [GitHub](https://github.com/MaastrichtU-Library/the-FAIR-extension).

3. 🌐 **Repository**: The FAIR extension project is publicly available on [GitHub](https://github.com/MaastrichtU-Library/the-FAIR-extension).

4. 📖 **User documentation**: The README.md file serves as the primary user documentation, providing a quickstart guide for both users and developers.

5. 📜 **Software licensing and compatibility**: The FAIR extension is licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

6. 🚀 **Deployment documentation**: Installation requirements and deployment instructions are provided in the README.md file.

7. 📚 **Citation**: The software can be cited using the provided CITATION.cff file, which can be converted into other formats using the [cff-converter Tool](https://github.com/citation-file-format/cff-converter-python).

8. 💻 **Developer documentation**: The README.md file provides a quickstart guide for developers, covering the main components and editing processes.

9. ✅ **Testing and quality**: Developers are encouraged to test the extension following the steps in the "Quickstart for Users" section of the README.md file after making any changes.

10. 📦 **Packaging and maintenance**: The extension is packaged as a Zip folder and is maintained on the GitHub repository. Developers can contribute by following the guidelines in the README.md file.