UNPKG

elsewhere

Version:

A node project that aims to replicate the functionality of the Google Social Graph API

54 lines (53 loc) 3.17 kB
{ "name": "webfinger", "description": "Client library for Host Meta (RFC 6415) and Webfinger", "homepage": "http://github.com/evanp/webfinger", "version": "0.1.1", "keywords": [ "webfinger", "hostmeta", "discovery", "xrd", "jrd", "lrdd" ], "engines": { "node": "0.8.x" }, "author": { "name": "Evan Prodromou", "email": "evan@status.net" }, "scripts": { "test": "vows -i test/*-test.js" }, "main": "./lib/webfinger.js", "directories": { "lib": "./lib/" }, "devDependencies": { "vows": "0.6.x", "express": "3.0.x" }, "dependencies": { "step": "0.0.x", "xml2js": "0.1.x" }, "repository": { "type": "git", "url": "git://github.com/evanp/webfinger.git" }, "licenses": [ { "type": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } ], "readme": "# Webfinger\n\nWebfinger and host-meta client library for Node.js.\n\nIt supports:\n\n* XRD documents\n* JRD documents\n* host-meta\n* host-meta.json\n* http and https\n\n## License\n\nCopyright 2012, StatusNet Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n## API\n\n### webfinger(address, callback)\n\nGets link data for the address `address` and returns it to function `callback`.\n\n`callback` should take two arguments: `err` for an error, and `jrd`\nfor a JRD representation of the Webfinger data.\n\nNote that the data is returned in JRD format even if it's in XRD\nformat on the server.\n\n### hostmeta(address, callback)\n\nGets link data for the host at `address` and returns it to function `callback`.\n\n`callback` works just like with `webfinger()`.\n\n### discover(address, callback)\n\nGets link data for `address` and returns it to function `callback`.\n\nIf you've got an address and you don't want to bother figuring out if it's a \nwebfinger or a hostname, call this and we'll do it for you.\n\n`callback` works just like with `webfinger()`.\n\n## Testing\n\nThe tests set up servers that listen on ports 80 and 443. On most\nUnix-like systems, you have to be root to listen on ports below 1024 or whatever.\n\nSo, to run the unit tests, you have to go:\n\n sudo npm test\n\nIt's probably not a good idea to sudo any script without thinking\nabout it pretty hard. I suggest that if you're doing development, you\ndo it in a virtual machine so you're not sudo'ing dangerous stuff on\nyour main computer.\n\n# Bugs\n\nBugs welcome, see:\n\n https://github.com/evanp/webfinger/issues\n", "readmeFilename": "README.md", "bugs": { "url": "https://github.com/evanp/webfinger/issues" }, "_id": "webfinger@0.1.1", "_from": "webfinger@0.1.x" }