Merge branch 'main' of https://github.com/kspcommunity/Mod-Parts-Lister

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 KSP Community 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.MD

@@ -1,44 +1,32 @@
 # Mod Parts Lister
 
-Welcome to Mod Parts Lister! This tool helps to generate a list of mods and their parts from the GameData folder to the data folder. It also provides functionalities to find specific parts and read crafts to retrieve their parts and the mods used by them.
+[![GitHub stars](https://img.shields.io/github/stars/kspcommunity/Mod-Parts-Lister?style=social)](https://github.com/kspcommunity/Mod-Parts-Lister/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/kspcommunity/Mod-Parts-Lister?style=social)](https://github.com/kspcommunity/Mod-Parts-Lister/network)
+[![GitHub watchers](https://img.shields.io/github/watchers/kspcommunity/Mod-Parts-Lister?style=social)](https://github.com/kspcommunity/Mod-Parts-Lister)
+[![GitHub contributors](https://img.shields.io/github/contributors/kspcommunity/Mod-Parts-Lister)](https://github.com/kspcommunity/Mod-Parts-Lister/graphs/contributors)
 
-## How it Works
+Welcome to Mod Parts Lister! This repository is part of the KSP Community organization on GitHub.
 
-- **index.js**: This script generates a list of mods and their parts from the GameData folder and stores the data in the "data" folder.
-- **find.js**: This script prompts the user to enter a part name and retrieves the name of its path.
-- **read.js**: This script reads a craft and retrieves its parts along with the mods used by it. Note that both the `find.js` and `read.js` rely on the data generated by `index.js` stored in the data folder.
+## Overview
 
-## Getting Started
+Mod Parts Lister is a tool for listing parts from various mods used in the game Kerbal Space Program (KSP). It provides an endpoint at [https://mod-parts.kspcommunity.com/data.json](https://mod-parts.kspcommunity.com/data.json) where you can access the data.
 
-To get started with Mod Parts Lister, follow these steps:
+## Interact with the Data
 
-1. Clone the repository: `git clone https://github.com/kspcommunity/Mod-Parts-Lister.git`
-2. Navigate to the project directory: `cd Mod-Parts-Lister`
-3. Install dependencies: `npm install`
-4. Run the index.js script to generate the mod parts list: `node index.js`
-5. Use `find.js` or `read.js` scripts as per your requirement.
+You can interact with the data provided by Mod Parts Lister using the [Craft File Reader](https://github.com/kspcommunity/Craft-File-Reader) repository.
 
-## How to Contribute
+## Acknowledgements
 
-We welcome contributions from the community to improve Mod Parts Lister. If you'd like to contribute, here's how you can do it:
+We would like to express our gratitude to Curseforge and Spacedock for their invaluable resources and support, without which this project would not have been possible.
 
-1. **Fork** the repository.
-2. **Clone** your forked repository to your local machine.
-3. Create a new branch for your feature or bug fix: `git checkout -b feature-name`
-4. Make your changes and ensure they work as expected.
-5. Commit your changes: `git commit -am 'Add new feature'`
-6. Push to your branch: `git push origin feature-name`
-7. Create a new pull request, explaining your changes thoroughly.
+## Disclaimer
 
-Please ensure your pull requests adhere to the following guidelines:
-- Follow the existing code style.
-- Test your changes thoroughly.
-- Provide descriptive commit messages.
+KSP Community is an independent entity and is not affiliated with Curseforge, Spacedock, or Intercept Games.
 
-Your name could be here too! Start contributing today.
+## Additional Information
 
-## Support
+For more information about KSP Community, please visit our [main website](https://kspcommunity.com). Our Privacy Policy and Terms of Service are available on our website.
 
-If you encounter any issues or have suggestions for improvement, feel free to [open an issue](https://github.com/kspcommunity/Mod-Parts-Lister/issues) on GitHub.
+If you need further assistance or have any questions, feel free to reach out to us at [[email protected]](mailto:info@kspcommunity.com).
 
-Happy modding! 🚀🛠️
+Join our Discord server: [https://discord.gg/YCZ5YhQQ8A](https://discord.gg/YCZ5YhQQ8A)