diff --git a/README.md b/README.md index 36a64ad..ca8bfcd 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,19 @@ -# API documentation of TyrePro +# API Documentation for TyrePro -## How it's written? +The documentation follows the OpenAPI 3.0.0 specifications. You can read the YAML files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar. -The documentations follow the OpenAPI 3.0.0 specifications. You can read the yaml-files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar. +## Getting Started -## How to get started? +Explore the endpoints of the common.yaml file! There you will find some general points and ways to create a session. Explore the other YAML files to check which permissions (sessions) you need, and let's get started! -1. Explore the endpoints of the common.yaml! There you find some general points and the ways of how to create a session. -2. Explore the other yaml files, check which permissions (sessions) you need and let's go! +## API Stability -## Is the API stable? +The API undergoes frequent updates and improvements to provide the best service and stay current. We encourage you to follow our Git repository for updates. -*The only constant is change.* Even when it may sound rough, but it's the truth. During development on a specific part, there will be a lot of changes. Someone requests, something new (or changed) and there will be changes. Further we want to provide you and our customers best service and keep our software up to date. +## Pricing -Follow this git repository, track changes and stay tuned! +We've charging plans dependant on your usage requirements. If you have doubts, please contact us and explain your goals and what you want to achieve. Special requirements or endpoints will be charged for customization on a per-hour basis. -## What about pricing? +## Have More Questions? -We've charging plans dependant on your usage requirements. Please contact us and explain your wish and what you want to achive. - -Special requirements or endpoints will get charged as customizing on an per hour base. - -## I've more questions! - -Don't hesitate to visit our [homepage](https://prm-ag.de) to contact us! +Feel free to visit our [homepage](https://prm-ag.de) and reach out to us with any questions or inquiries!