add basic info to readme #449
Merged
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
ens-bwalts
suggested changes
Nov 27, 2019
ens-bwalts
approved these changes
Nov 27, 2019
mira13
approved these changes
Dec 2, 2019
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.
Description
The README.md is a bit dull, add some basic info.
Use case
Added some basic info just like the other ensembl APIs
Benefits
Basic info about the API, specially how to contact us.
Possible Drawbacks
If applicable, describe any possible undesirable consequence of the changes.
none
Testing
Have you added/modified unit tests to test the changes?
no
If so, do the tests pass/fail?
Have you run the entire test suite and no regression was detected?