Merge branch 'master' of https://github.com/Lian-D/ArticleTrim

README.md

@@ -1,4 +1,56 @@
 # Summary.js #
-
 ![](https://api.travis-ci.org/Lian-D/Summary.JS.svg?branch=master) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+
+A lightweight paragraph summarizer library that can be manipulated to preferred specifications. Utilizing the lex rank algorithm to score sentences 
+ - [Demo](https://lian-d.github.io/Summary.js/)
+
+
+ ## Main
+
+ ```text
+dist/
+├── summary.js        (UMD)
+├── summary_minfied.js    (UMD, compressed)
+├── summary_legacy.js s (Old legacy summarizer)
+└── summary_legacy_minfied.js    (Old legacy summarizer, compressed)
+```
+### Installation
+Include files:
+
+```html
+<script src="/path/to/summary.js"></script>
+
+```
+### Usage
+```js
+summarize(text, sentences, keywordsInt);
+```
+where text is the input text
+
+sentences is the number of sentences you want to return
+
+keywordsInt is the number of keywords you want to factor in during the scoring process
+
+This will return an object:
+```js
+{
+keywords: an array of keywords,
+text: the raw string summary
+characterSummed: the number or words in this summary
+characterOrig: the number of words in the original summary
+reductionfactor: the % reduction factor
+}
+```
+## How does it work?
+The core algorithm works in a couple of steps
+1. Calculate the occurrence of each word in the text.
+2. Detect which periods represent the end of a sentence. (e.g "Dr." does not).
+3. Split up the text into individual sentences.
+4. Rank sentences by the sum of their words' points and keyword points.
+5. Return X of the most highly ranked sentences in chronological order.
+
+## Contributing
+
+Please read through our [contributing guidelines](CONTRIBUTING.md).