From 96b2621ff54695b40d58f09cde8cedb0e6a60ed1 Mon Sep 17 00:00:00 2001 From: Adam Pogwizd Date: Fri, 19 Oct 2018 15:27:14 -0500 Subject: [PATCH] Updated README: minor grammar improvements as well as section for contributing --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8f77186..493ed11 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Note: Readability requires Elixir 1.3 or higher. ### Examples -#### Just pass url +#### Just pass a url ```elixir url = "https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58" summary = Readability.summarize(url) @@ -85,7 +85,7 @@ html ### 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 ```elixir @@ -114,10 +114,20 @@ To run the test suite: * [x] Summarize function * [ ] 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 +**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 * [readability.js](https://github.com/mozilla/readability) is a standalone version of the readability library used for Firefox Reader View.