From 88c109adee63a245742b4bc566a612cd5bc120e9 Mon Sep 17 00:00:00 2001 From: glax Date: Sun, 3 Sep 2023 18:45:58 +0200 Subject: [PATCH] Added README.md --- README.md | 123 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fed1b32 --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ + + + + +
+
+ +

Tranga-Website

+ +

+ Automatic Manga and Metadata downloader +

+

+ This is the Website for Tranga (API) +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
  2. +
  3. + Getting Started +
  4. +
  5. Roadmap
  6. +
  7. Contributing
  8. +
  9. License
  10. +
  11. Acknowledgments
  12. +
+
+ + + + +## About The Project + +Tranga-Website is the Web-frontend to [Tranga](https://github.com/C9Glax/tranga) (the API). It displays information aquired from Tranga and can create Jobs (Manga-Downloads). + +### What this does do (and nothing else) + +This repo makes HTTP-requests to the [Tranga-API](https://github.com/C9Glax/tranga) to display it's present configuration. + +### Built With + +- nginx +- HTML, CSS, and barebones Javascript +- 💙 Blåhaj 🦈 + +

(back to top)

+ + +## Getting Started + +There is a single release: + + +### Docker + +Download [docker-compose.yaml](https://github.com/C9Glax/tranga-website/blob/cuttingedge/docker-compose.yaml) and configure to your needs. +The `docker-compose` also includes [Tranga](https://github.com/C9Glax/tranga) as backend. For its configuration refer to the repo README. + + +## Roadmap + +- [ ] ❓ + +See the [open issues](https://github.com/C9Glax/tranga-website/issues) for a full list of proposed features (and known issues). + +

(back to top)

+ + + + +## Contributing + +The following is copy & pasted: + +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 GNU GPLv3 License. See `LICENSE.txt` for more information. + +

(back to top)

+ + + + +## Acknowledgments + +* [Choose an Open Source License](https://choosealicense.com) +* [Font Awesome](https://fontawesome.com) +* [Best-README-Template](https://github.com/othneildrew/Best-README-Template/tree/master) + +

(back to top)