About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Golang

Installation

To install gorinth in you golang project, run the command: go get github.com/gearsdatapacks/gorinth

(back to top)

Usage

Project Use the GetProject function to fetch a project from modrinth Project methods:

• GetVersions - Returns a list of project versions

• GetLatestVersion - Returns the latest version of the project

• GetSpecficVersion - Returns the version corresponding to the given semver string

• CreateVersion - Publishes the given version to the project page on Modrinth

• Modify - Modifies the project, overwriting the set fields in the given project

(back to top)

Roadmap

• Add support of all modrinth API routes
• Add support for the upcoming Datapack Hub API

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the LGPL License. See LICENSE.md for more information.

(back to top)

Contact

Discord Server
Email

Project Link: https://github.com/GearsDatapacks/gorinth

(back to top)

Acknowledgments

• Readme based on Best readme template

(back to top)