Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.92 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.92 KB
Raw

Fleece

Node.js/io.js module. Fetch and describe URLs (Tweets, GitHub repos, etc). Useful for IRC bots.

npm version

Build Status

Floobits Status

Install

Add fleece to your package.json or npm install fleece.

Use

The main function you'll want to use is describe_url(). Give it a URL and it will give you a one-line description:

let fleece = require("fleece");
fleece.describe_url("https://github.com/Floobits/floobits-sublime", function (err, result) {
  if (err) {
    console.error("Error fetching URL:", err);
    return;
  }
  if (!result) {
    // No outright error, but empty <title>, URL is an image, etc
    console.log("No result");
    return;
  }
  console.log(result);
});

Assuming no network errors, the output should be:

floobits-sublime (11 stars 213 forks) Floobits real-time collaboration plugin for Sublime Text 2 and 3

This works for more than just GitHub URLs. Fleece also supports Twitter and Hacker News:

describe_url("https://twitter.com/SpaceX/status/556131313905070081");

<@SpaceX> Close, but no cigar. This time. https://vine.co/v/OjqeYWWpVWK  (12,216 retweets, 9,328 favorites)

describe_url("https://github.com/Floobits/floobits-sublime");

floobits-sublime (11 stars 213 forks) Floobits real-time collaboration plugin for Sublime Text 2 and 3

describe_url("https://news.ycombinator.com/item?id=6577671");

Accidentally Turing-Complete (http://beza1e1.tuxen.de/articles/accidentally_turing_complete.html) 107 points by ggreer 533 days ago | 48 comments

For another usage example, see floobot.