shadowfacts
/
readability
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README: minor grammar improvements as well as section for contributing

This commit is contained in:
Adam Pogwizd 2018-10-19 15:27:14 -05:00 committed by Jaehyun Shin
parent 5dd52d5698
commit 96b2621ff5
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -33,7 +33,7 @@ Note: Readability requires Elixir 1.3 or higher.
### Examples ### Examples
#### Just pass url #### Just pass a url
```elixir ```elixir
url = "https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58" url = "https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58"
summary = Readability.summarize(url) summary = Readability.summarize(url)
@ -85,7 +85,7 @@ html
### Options ### Options
If result is different with your expectation, you can add options. If the result is different from your expectations, you can add options to customize it.
#### Example #### Example
```elixir ```elixir
@ -114,10 +114,20 @@ To run the test suite:
* [x] Summarize function * [x] Summarize function
* [ ] Convert relative paths into absolute paths of `img#src` and `a#href` * [ ] Convert relative paths into absolute paths of `img#src` and `a#href`
**Contributions are welcome!** ## Contributions are welcome!
Check out [the main features milestone](https://github.com/keepcosmos/readability/milestones) and features of related projects below Check out [the main features milestone](https://github.com/keepcosmos/readability/milestones) and features of related projects below
**Contributing**
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
## Related and Inpired Projects ## Related and Inpired Projects
* [readability.js](https://github.com/mozilla/readability) is a standalone version of the readability library used for Firefox Reader View. * [readability.js](https://github.com/mozilla/readability) is a standalone version of the readability library used for Firefox Reader View.