{"_id":"readability-api","_rev":"27-681bd5353d1dd7b0f9ec7cd9c58a2b60","name":"readability-api","description":"A Node wrapper for the Readability APIs","dist-tags":{"latest":"1.0.1"},"versions":{"0.0.1":{"name":"readability-api","version":"0.0.1","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test"},"devDependencies":{"mocha":"1.x"},"dependencies":{"node-oauth":"*"},"repository":"","keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"BSD","_id":"readability-api@0.0.1","dist":{"shasum":"1f8258e652287035d8d57e82530328edb1031d42","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-0.0.1.tgz","integrity":"sha512-KiMZa/BLb8WEZB7qe9N9R/KLnQp3T6xqNndY8sucdML+MyltZjmwuEGxcNMeIIOkoGr+lWJhjQUKQtuTTB68zA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDSVM8amoBRRZsyX5fbrJwe4ZlsufOp9DddcDrWFHNbzQIgEYFkTjPWP3pnKr6wadNOGopq3F01cdum8kwX0JwM1I8="}]},"_npmVersion":"1.1.65","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}],"directories":{}},"0.1.0":{"name":"readability-api","version":"0.1.0","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test"},"devDependencies":{"mocha":"1.x","nock":"0.x"},"dependencies":{"request":"2.x","underscore":"1.x"},"repository":{"type":"git","url":"https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"BSD","bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"_id":"readability-api@0.1.0","dist":{"shasum":"44f5eb49afafb41536ce2453eb4a38460cb314a2","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-0.1.0.tgz","integrity":"sha512-gzBvBsEpUVrG81wPcHiXd3mnzfEfQRFJcP0wB7Z1FZ6qP0rlcX5Y6fIsaFOYf1e6KMWx0QWxK234Ld/qodgNbA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCYCA+dXBSjCCaTecdYUycyPoM5U3h2Cw3rcCB5Igy2hAIgcRCmLsuobiDCKvwUHqfMj8GRETPRvnm2SAf8mQGYY80="}]},"_from":".","_npmVersion":"1.3.8","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}]},"0.2.0":{"name":"readability-api","version":"0.2.0","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test"},"devDependencies":{"mocha":"1.x","nock":"0.x"},"dependencies":{"request":"2.x","underscore":"1.x"},"repository":{"type":"git","url":"https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"MIT","bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"_id":"readability-api@0.2.0","dist":{"shasum":"d67059819957ce157b30d9ce055b09d8a41e3365","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-0.2.0.tgz","integrity":"sha512-aMLvgmQTMa79YHvM8tk8L9MLemKDrTl61LcQ0JZbGfHv0Aa3Q3Wp1iiefgrlTRSoLYRR3eb7UiV68BFKhPo5Bw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDibzwvJE5sZ1MGw5virHQdlvnEdv9rzZvy/cC0jUfe1AiEAtl7BHcT/e6tKSRyw7GKHvgiGyFhNTTW0okByWbqE9qA="}]},"_from":".","_npmVersion":"1.3.8","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}]},"0.3.0":{"name":"readability-api","version":"0.3.0","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test"},"devDependencies":{"mocha":"1.x","nock":"0.x"},"dependencies":{"request":"2.x","underscore":"1.x"},"repository":{"type":"git","url":"https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"MIT","_id":"readability-api@0.3.0","dist":{"shasum":"f39e69cea858d257a3db342f00ac2747189b5b50","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-0.3.0.tgz","integrity":"sha512-4ld5hlwyPBHCMy6verP1OUOg/7rM0ncBfDQFvUTu/XTG/kKf73kykQIcf97wcAZPU51h3HuuCuT5cpr38Vs9WA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC3hTbtLiWqvbex0UJ5M/QV/lhyEVd+0nI9D7ijNfPQrwIhAPq8d1pte38vWa/M7dyqITknkgdKvyV9N1lbBFTstfW3"}]},"_from":".","_npmVersion":"1.2.11","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}]},"0.4.0":{"name":"readability-api","version":"0.4.0","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test"},"devDependencies":{"mocha":"1.x","nock":"0.x"},"dependencies":{"request":"2.x","underscore":"1.x"},"repository":{"type":"git","url":"https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"MIT","bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"homepage":"https://github.com/robinjmurphy/node-readability-api","_id":"readability-api@0.4.0","dist":{"shasum":"17a87abecb7f1c6efdff79372d50e8190638e03f","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-0.4.0.tgz","integrity":"sha512-jzX3UWnh8tKIn7WfC+s6N4hbKifSVxrXxIhyaO2brzGHHCYlzc2F9WnWk79pF9Ux/tAh7GNQ1TU31CKkBDfO7w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFABEzsScSdcUqOOu5O2MBnVUYF5XWvqQ30Oj9ERaMJsAiEA7tdPjxYAqLV/aa7n+jtukWZNAd/Z//1cT9lWstLDwbY="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}]},"1.0.0":{"name":"readability-api","version":"1.0.0","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test","lint":"jshint .","posttest":"npm run lint"},"devDependencies":{"jshint":"^2.9.2","mocha":"^3.0.2","nock":"^8.0.0"},"dependencies":{"lodash":"^4.14.2","request":"^2.74.0"},"repository":{"type":"git","url":"git+https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"MIT","gitHead":"f8ead314278c1a75e5f27804d2dd1e7e986e28ef","bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"homepage":"https://github.com/robinjmurphy/node-readability-api#readme","_id":"readability-api@1.0.0","_shasum":"5ee55baac80b279b6835b16b13f447905dbbe0c3","_from":".","_npmVersion":"2.15.8","_nodeVersion":"4.4.7","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"dist":{"shasum":"5ee55baac80b279b6835b16b13f447905dbbe0c3","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-1.0.0.tgz","integrity":"sha512-D0pHEtqUHjBfJkZcJyI4glMIEi0NlaE8jSYEua8LPHTI96zsksuy7xHFEdIo45EsLjHCBuVi0MPtXKHnkvSRyA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBZUY821Pzxi8eUTXtMexM9NnxNxyMEtf4SSI56NJKfYAiEA8EMzH8Bo27m1T5GGTSp8DxRD0ADV/Z1O09mB53w0Rg8="}]},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/readability-api-1.0.0.tgz_1470857071191_0.4222521942574531"}},"1.0.1":{"name":"readability-api","version":"1.0.1","description":"A Node wrapper for the Readability APIs","main":"index.js","scripts":{"test":"make test","lint":"jshint .","posttest":"npm run lint"},"devDependencies":{"jshint":"^2.9.2","mocha":"^3.0.2","nock":"^8.0.0"},"dependencies":{"lodash":"^4.14.2","request":"^2.74.0"},"repository":{"type":"git","url":"git+https://github.com/robinjmurphy/node-readability-api.git"},"keywords":["readability"],"author":{"name":"robin@robinmurphy.co.uk"},"license":"MIT","gitHead":"238610768c872e300d09fc65b3c92c387046846d","bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"homepage":"https://github.com/robinjmurphy/node-readability-api#readme","_id":"readability-api@1.0.1","_shasum":"451d7701ab6a1ce42dc9b2fd757afbc799cbf515","_from":".","_npmVersion":"2.15.8","_nodeVersion":"4.4.7","_npmUser":{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"},"dist":{"shasum":"451d7701ab6a1ce42dc9b2fd757afbc799cbf515","tarball":"https://registry.npmjs.org/readability-api/-/readability-api-1.0.1.tgz","integrity":"sha512-deZJdBR+01GCfccXMyzgRJCUMP4xSdVgtMHhinEQkn6I4kQb9udN94IK3fNSDHvcxMz+bkQfLTLhDTvPenHWzw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCkCEMWv+ejVikBsN/8jvRQl4FSFjzlijcRVHacYQ8tlQIgVwkdLTpTuSIH/PBjkE7Qq7zTfF1TBAx70rVayl/8mo0="}]},"maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/readability-api-1.0.1.tgz_1471100063235_0.9905546882655472"}}},"readme":"## node-readability-api\n\n[![Build Status](https://travis-ci.org/robinjmurphy/node-readability-api.svg?branch=master)](https://travis-ci.org/robinjmurphy/node-readability-api) [![Code Climate](https://codeclimate.com/github/robinjmurphy/node-readability-api/badges/gpa.svg)](https://codeclimate.com/github/robinjmurphy/node-readability-api)\n\nThis is a Node client for the [Readability](http://www.readability.com/) API. It supports the [Reader API](http://www.readability.com/developers/api/reader), [Parser API](http://www.readability.com/developers/api/parser) and [Shortener API](http://www.readability.com/developers/api/shortener).\n\n### Installation\n\n```bash\nnpm install --save readability-api\n```\n\n### Usage\n\nInitialize the client\n\n```javascript\nvar readability = require('readability-api');\n\nreadability.configure({\n    consumer_key: 'some_consumer_key',\n    consumer_secret: 'some_consumer_secret',\n    parser_token: 'some_parser_token'\n});\n```\n\n### Authentication\n\nRetrieve an OAuth access token and access token secret for a user\n\n```javascript\nreadability.xauth('some_username', 'some_password', function (err, tokens) {\n  // Use tokens.oauth_token and tokens.oauth_token_secret when creating a Reader API client\n})\n```\n\n#### Reader API\n\nTo use the Reader API, create a Reader object using an OAuth token and token secret\n\n```javascript\nvar reader = new readability.reader({\n  access_token: 'some_access_token',\n  access_token_secret: 'some_access_token_secret'\n});\n```\n\n##### User information\n\n```javascript\n// Get information about the current user\nreader.user(function (err, user) {\n  //...\n});\n```\n\n##### Bookmarks\n\n```javascript\n// Get all bookmarks - response contains both metadata (pagination etc.) and an array of bookmarks\nreader.bookmarks(options, function (err, bookmarks) {\n   //...\n});\n\n// Get a bookmark by its id\nreader.bookmark('some_bookmark_id', function (err, bookmark) {\n   //...\n});\n\n// Add a bookmark - returns the created bookmark\nreader.addBookmark('http://some.bookmark.url.com/article.html', function (err, bookmark) {\n   //...\n});\n\n// Remove a bookmark - success is a boolean\nreader.removeBookmark('some_bookmark_id', function (err, success) {\n   //...\n});\n\n// Archive a bookmark - returns the archived bookmark\nreader.archiveBookmark('some_bookmark_id', function (err, bookmark) {\n   //...\n});\n\n// Unarchive a bookmark - returns the bookmark\nreader.unarchiveBookmark('some_bookmark_id', function (err, bookmark) {\n   //...\n});\n\n// Favourite a bookmark - returns the favourited bookmark\nreader.favouriteBookmark('some_bookmark_id', function (err, bookmark) {\n   //...\n});\n\n// Unavourite a bookmark - returns the bookmark\nreader.unfavouriteBookmark('some_bookmark_id', function (err, bookmark) {\n   //...\n});\n\n```\n\n##### Tags\n\n```javascript\n// Get all of the current user's tags - returns an array of tags\nreader.userTags(function (err, tags) {\n   //...\n});\n\n// Get all of the tags for a bookmark - returns an array of tags\nreader.tags('some_bookmark_id', function (err, tags) {\n   //...\n});\n\n// Add tags to a bookmark - returns an array of tags\nreader.addTags('some_bookmark_id', ['tag1', 'tag2', 'tag3'], function (err, bookmark) {\n    //...\n});\n\n// Remove a tag from a bookmark - returns the bookmark\nreader.removeTag('some_bookmark_id', 'some_tag_id', function (err, bookmark) {\n   //...\n});\n```\n\n##### Articles\n\n```javascript\n// Get a single article\nreader.article('some_article_id', function (err, article) {\n   //...\n});\n```\n\n#### Parser API\n\n```javascript\n// Create a parser object\nvar parser = new readability.parser();\n\n// Parse an article\nparser.parse('http://some.bookmark.url.com/article.html', function (err, parsed) {\n  //...\n});\n\n// Get the Parser confidence level - returns a number between 0 and 1\nparser.confidence('http://some.bookmark.url.com/article.html', function (err, confidence) {\n  //...\n});\n```\n\n#### Shortener API\n\n```javascript\n// Create a shortener object\nvar shortener = new readability.shortener()\n\n// Create a short URL - returns the short URL as a string and additional URL data\nshortener.shorten('http://www.example.com/article.html', function(err, shortUrl, data) {\n  //...\n});\n\n// Get information about a short URL\nshortener.url('some_url_id', function(err, url) {\n  //...\n});\n```\n","maintainers":[{"name":"robinmurphy","email":"robin@robinmurphy.co.uk"}],"time":{"modified":"2022-06-26T09:15:15.493Z","created":"2013-08-22T21:18:13.072Z","0.0.1":"2013-08-22T21:18:15.203Z","0.1.0":"2013-08-25T11:18:49.515Z","0.2.0":"2013-08-28T20:15:40.086Z","0.3.0":"2013-09-04T18:20:50.394Z","0.4.0":"2014-04-19T17:54:04.870Z","1.0.0":"2016-08-10T19:24:31.955Z","1.0.1":"2016-08-13T14:54:24.981Z"},"author":{"name":"robin@robinmurphy.co.uk"},"repository":{"type":"git","url":"git+https://github.com/robinjmurphy/node-readability-api.git"},"homepage":"https://github.com/robinjmurphy/node-readability-api#readme","keywords":["readability"],"bugs":{"url":"https://github.com/robinjmurphy/node-readability-api/issues"},"license":"MIT","readmeFilename":"README.md"}