https://github.com/fxding/greader

An Collector/Reader for readme documentations of Github repos
https://github.com/fxding/greader

Last synced: about 2 months ago
JSON representation

An Collector/Reader for readme documentations of Github repos

• Host: GitHub
• URL: https://github.com/fxding/greader
• Owner: fxding
• Created: 2015-05-10T06:28:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-12T15:14:58.000Z (about 9 years ago)
• Last Synced: 2024-05-19T03:15:58.705Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 2.44 MB
• Stars: 101
• Watchers: 6
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-electron-zh - GReader - Collect and read offline readme files of GitHub repos. (Apps / Open Source)
• awesome-electron - GReader - Collect and read offline readme files of GitHub repos.  (Apps / Git)

README

        
Github Readme Reader is a collector of readme documentations, you can use it to collect the readme documentations you want to read it.

All the Readme file will be downloaded on your local, you can read it at any where even you are offline.

## Usage

```

npm install     // install dependencies

npm start       // start for dev

npm run release // create app

```

Add readme documentation of repositories you love on the top navigator.

Learn more about build on [electron-boilerplate](https://github.com/szwacz/electron-boilerplate).

## ScreenShot

![img](./doc/screenshot.png)

## TODO

- Delete readme file

- Welcome page

- Content search