diff --git a/README.md b/README.md index b8440e3..09f026c 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -# GitToText-Backend \ No newline at end of file +# GitToText-Backend + +[![GitHub issues](https://img.shields.io/github/issues/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/issues) +[![GitHub forks](https://img.shields.io/github/forks/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/network) +[![GitHub stars](https://img.shields.io/github/stars/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/stargazers) +[![GitHub license](https://img.shields.io/github/license/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/blob/main/LICENSE) + +GitToText-Backend is a Flask-based backend application for the GitToText project. It handles the processing of GitHub repositories and serves the frontend application. + +## Features + +- **Fetch Files**: Retrieve all files from a specified GitHub repository. +- **Process Content**: Convert and clean the content for easy readability. +- **API Endpoints**: Provide endpoints for the frontend to interact with. + +## How to Use + +The backend provides an API endpoint that the frontend interacts with to fetch and process repository data. + +## Deployment + +The backend is deployed on Vercel. Make sure to set up the necessary environment variables and configure the backend URL correctly in the frontend application. + +For detailed deployment steps, refer to the Vercel documentation. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.