Updated readme file #8
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
Added intro of basic docs to the readme file. And added a link where to find more documentation.
kelunik
requested changes
Oct 11, 2017
README.md
Outdated
| ``` | ||
|
|
||
| ## More documentation | ||
| More documentation can be found in the [docs folder](docs/) |
There was a problem hiding this comment.
Please link to https://amphp.org/beanstalk/ instead of the ./docs directory.
README.md
Outdated
| @@ -4,10 +4,27 @@ | |||
| [](https://coveralls.io/github/amphp/beanstalkd?branch=master) | |||
|  | |||
|
|
|||
| `amphp/beanstalk` is a non-blocking BeanstalkD client for [Amp](https://github.com/amphp/amp). | |||
| `amphp/beanstalk` is an asynchronous client for [Beanstalk](http://kr.github.io/beanstalkd/). | |||
There was a problem hiding this comment.
How about for Beanstalk based on Amp for PHP?
|
@ArraysNL You might want to fix your e-mail address in the commit, it doesn't properly link to your GitHub account. |
External link to the documentation and better excerpt of Beanstalk in general.
ArraysNL
commented
Oct 11, 2017
|
Thanks! |
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.
Added intro of basic docs to the readme file. And added a link where to find more documentation.
Fixes: #7