Permalink
Browse files

Updated README and package.json

  • Loading branch information...
rumpl committed Mar 20, 2013
1 parent 837e452 commit f72013f0f47b560f0682485af996af214cca2fe5
Showing with 58 additions and 4 deletions.
  1. +25 −3 README.md
  2. +33 −1 package.json
View
@@ -1,15 +1,37 @@
# md-read
-Save articles on the web in Markdown
+Save articles on the web in Markdown.
-Soon on npm.
+`md-read` uses node-readability to extract an article from a web page and saves it to disk in Markdown format for
+you to read later.
+
+## Installation
+
+```
+npm install -g md-read
+```
+
+## Configuration
+
+When first run it will create an .md-read.json file with the current directory as the default path for saving
+articles.
+
+The configuration is a simple json file with one key :
+```javascript
+{
+ "directory": "/some/path"
+}
+```
+
+Tip : put it in Dropbox for a free personal distributed read-it-later service.
## Usage
```
md-read <URL>
```
-And it will save the file in the current diretory in Markdown format
+
+And it will save the file in the current directory in Markdown format
## License
View
@@ -1,6 +1,38 @@
{
+ "name": "md-read",
+ "description": "Save web articles in Markdown to read later",
+ "version": "0.1.0",
+ "homepage": "https://github.com/rumpl/md-read",
+ "author": {
+ "name": "rumpl",
+ "email": "lukic.djordje@gmail.com"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/rumpl/md-read.git"
+ },
+ "bugs": {
+ "url": "https://github.com/rumpl/md-read/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/rumpl/c/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "bin/md-read",
+ "bin": {
+ "md-read": "bin/md-read"
+ },
+ "engines": {
+ "node": "~0.8.2"
+ },
+ "scripts": {
+ "test": "grunt test"
+ },
"dependencies": {
"node-readability": "git://github.com/rumpl/node-readability.git",
"html-md": "~2.0.2"
- }
+ },
+ "keywords": ["markdown", "articles"]
}

0 comments on commit f72013f

Please sign in to comment.