From c89fdd2588299f49cc8250f103bab68df9ccb12b Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Mon, 5 Feb 2024 23:56:42 +0100 Subject: [PATCH] docs: Add README & contribution guidelines --- CONTRIBUTING.md | 97 ++++++++++++++++ README.md | 108 ++++++++++++++++++ .../revanced-headline-vertical-dark.svg | 1 + .../revanced-headline-vertical-light.svg | 1 + assets/revanced-logo/revanced-logo.svg | 1 + 5 files changed, 208 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 assets/revanced-headline/revanced-headline-vertical-dark.svg create mode 100644 assets/revanced-headline/revanced-headline-vertical-light.svg create mode 100644 assets/revanced-logo/revanced-logo.svg diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b140bcf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,97 @@ +

+ + + + +
+ + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + + +
+
+ Continuing the legacy of Vanced +

+ +# 👋 Contribution guidelines + +This document describes how to contribute to ReVanced API. + +## 📖 Resources to help you get started + +* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on +* [Issues](https://github.com/ReVanced/revanced-api/issues) are where we keep track of bugs and feature requests + +## 🙏 Submitting a feature request + +Features can be requested by opening an issue using the +[Feature request issue template](https://github.com/ReVanced/revanced-api/issues/new?assignees=&labels=Feature+request&projects=&template=feature-request.yml&title=feat%3A+). + +> **Note** +> Requests can be accepted or rejected at the discretion of maintainers of ReVanced API. +> Good motivation has to be provided for a request to be accepted. + +## 🐞 Submitting a bug report + +If you encounter a bug while using ReVanced API, open an issue using the +[Bug report issue template](https://github.com/ReVanced/revanced-api/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+). + +## 📝 How to contribute + +1. Before contributing, it is recommended to open an issue to discuss your change +with the maintainers of ReVanced API. This will help you determine whether your change is acceptable +and whether it is worth your time to implement it +2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev` +3. Commit your changes +4. Submit a pull request to the `dev` branch of the repository and reference issues +that your pull request closes in the description of your pull request +5. Our team will review your pull request and provide feedback. Once your pull request is approved, +it will be merged into the `dev` branch and will be included in the next release of ReVanced API + +❤ī¸ Thank you for considering contributing to ReVanced API, +ReVanced diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ce803d --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +

+ + + + +
+ + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + + +
+
+ Continuing the legacy of Vanced +

+ +# 🚀 ReVanced API + +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-api/release.yml) +![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) + +API server for ReVanced. + +## ❓ About + +ReVanced API is a server that is used as the backend for ReVanced. +ReVanced API powers [ReVanced Manager](https://github.com/ReVanced/revanced-manager) with updates and ReVanced Patches, +and acts as a data source for [ReVanced Website](https://github.com/ReVanced/revanced-website). + +## đŸ’Ē Features + +Some of the features of ReVanced API include: + +- đŸ“ĸ **Announcements**: Push announcements grouped by channels +- ℹī¸ About: Get more information such as a description, ways to donate and links about the hoster of ReVanced API +- 🧩 Patches: Get the latest updates of ReVanced Patches directly from ReVanced API +- đŸ‘Ĩ Contributors: List all contributors involved in the project + +## 🚀 How to get started + +1. Clone the repository +2. Set up the environment variables in a `.env` file using the `.env.example` file as a template +3. Configure the `configuration.toml` file using the `configuration.toml.example` file as a template +4. Run the server using `gradlew run --args=start` + +## 📚 Everything else + +### 📙 Contributing + +Thank you for considering contributing to ReVanced API. You can find the contribution guidelines [here](CONTRIBUTING.md). + +### 🛠ī¸ Building + +In order to build ReVanced API, follow these steps: + +1. Clone the repository +2. Run `gradlew build` to build the project + +## 📜 Licence + +ReVanced API is licensed under the GPLv3 licence. Please see the [licence file](LICENSE) for more information. +[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and +modify ReVanced API as long as you track changes/dates in source files. +Any modifications to ReVanced API must also be made available under the GPL along with build & install instructions. diff --git a/assets/revanced-headline/revanced-headline-vertical-dark.svg b/assets/revanced-headline/revanced-headline-vertical-dark.svg new file mode 100644 index 0000000..a59bfb5 --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-headline/revanced-headline-vertical-light.svg b/assets/revanced-headline/revanced-headline-vertical-light.svg new file mode 100644 index 0000000..3c5eecc --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-logo/revanced-logo.svg b/assets/revanced-logo/revanced-logo.svg new file mode 100644 index 0000000..901e191 --- /dev/null +++ b/assets/revanced-logo/revanced-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file