https://github.com/bennymeg/readmesummarizer
Summaries readme file into few sentences
https://github.com/bennymeg/readmesummarizer
readme summarization summarizer
Last synced: 3 months ago
JSON representation
Summaries readme file into few sentences
- Host: GitHub
- URL: https://github.com/bennymeg/readmesummarizer
- Owner: bennymeg
- License: mit
- Created: 2019-02-11T11:05:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T10:31:01.000Z (about 2 years ago)
- Last Synced: 2025-03-18T13:28:06.471Z (3 months ago)
- Topics: readme, summarization, summarizer
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Readme Summarizer
Summaries markdown readme files into few sentences. Get short description for any repository easily.
[](https://github.com/bennymeg/ReadmeSummarizer/blob/master/LICENSE)
[](https://www.npmjs.com/package/readme-summarizer)
[](https://david-dm.org/bennymeg/ReadmeSummarizer)
## Installation
```bash
npm install --save readme-summarizer
```
## Usage
### Import library:
```javascript
import { ReadmeSummarizer } from 'readme-summarizer';
```
### Get readme summary from URL:
```javascript
let readmeUrl = "https://raw.githubusercontent.com/bennymeg/ReadmeSummarizer/master/README.md";
let shortSummary = true;
// get readme summary asynchronously from URL
ReadmeSummarizer.fromUrl(readmeUrl, shortSummary).then((response) => {
console.log(response);
// prints: "Summaries markdown readme files into few sentences."
}).catch((error) => {
console.error('Error:', error);
});
```
### Get readme summary from text:
```javascript
let readmeAsText = "#Your markdown readme text string...";
let shortSummary = false;
// get readme summary from text string
ReadmeSummarizer.fromText(readmeUrl, shortSummary);
```
## Supported Environments ##
- 💻 Browser (including browserify / webpack based environments [such as Angular])
- 🖥 Node.js
## Documentation ##
- 👨🏼💻 [API](https://github.com/bennymeg/ReadmeSummarizer/blob/master/docs/API.md),
- 👩🏼🏫 [Examples](https://github.com/bennymeg/ReadmeSummarizer/blob/master/docs/examples),
- 🖋 [Licence](https://github.com/bennymeg/ReadmeSummarizer/blob/master/LICENSE)
## Support ##
If you're having any problem, please [raise an issue](https://github.com/bennymeg/ReadmeSummarizer/issues/new) on GitHub and we'll be happy to help.
## Contribute ##
- 👾 [Issue Tracker](https://github.com/bennymeg/ReadmeSummarizer/issues),
- 📦 [Source Code](https://github.com/bennymeg/ReadmeSummarizer/)
Any help generifying this repository will be very much appreciated.
Before submitting a pull request, please make sure that you include tests, and that [jshint](http://jshint.com) runs without any warnings: [Download VSCode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.jshint).
## Test ##
Run the test suite by executing:
```sh
$ npm test
```
___
**Author:** Benny Megidish.