NREL / api-umbrella

Open source API management platform
MIT License
2.03k stars 326 forks source link

Added Detailed Section in README.md that describes the Primary Features of API Umbrella #664

Open skhatib07 opened 2 months ago

skhatib07 commented 2 months ago

The documentation in the README.md significantly lacked a good explanation of what API Umbrella provides to the users of the Program. I added the following sections to the README.md to emphasize the benefits of using API Umbrella:

Features lists a general summary to each one of the core features of API Umbrella. Each bullet point under this section has a link to the comprehensive summary of each core feature.

API Key Management describes the benefits of using the API key generator included with API Umbrella

Rate Limiting illustrates the traffic management that comes standard with all API Umbrella configurations

Analytics & Reporting discusses the enhanced metrics that are viewable within the API Umbrella hub

Centralized API Access emphasizes the flexibility of API Umbrella towards adding new API endpoints using a unified entry point

Native Documentation Support explains the native documentation warehouse that is accessible through API Umbrella

Each one of these headings give a detailed report in regards to the features that API Umbrella has, making it more appealing to choose API Umbrella to it's fullest potential.