Added Detailed Section in README.md that describes the Primary Features of API Umbrella #664
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.