<commit_before>node-ostatus
============

An implementation of the [OStatus](http://ostatus.org) protocol stack for node.js

*** Ongoing development on the master branch until I reach a first stable 0.1 release ***

Copyright (C) 2010 <NAME> <<EMAIL>>

Install
-------

If you are using npm (the node packet manager), installing is as easy as:
    npm install ostatus


Dependencies
------------

If you are using this from source, you can install the dependencies using npm from the root of the source folder:
    npm bundle

Or you can install all dependencies manually:
- [node](http://nodejs.org/) v4+ is required, I'm developing against trunk.
- [node-o3-xml](https://github.com/ajaxorg/node-o3-xml/)
- [Mu](https://github.com/raycmorgan/Mu/tree/v2) the v2 branch

Documentation
-------------

The API is documented in the [[wiki | http://github.com/eschnou/node-ostatus/wiki]]. 

Progress
--------

The following pieces of the protocol are implemented:

-  [webfinger](http://code.google.com/p/webfinger/): 
   * Lookup a user account and return the user meta in a JSON format
   * Rendering of host/user meta based on a JSON input object
-  [pubsubhubbub](http://code.google.com/p/pubsubhubbub/): 
   * Subscribe/Unsubscribe to a topic on another hub
   * Verify a subscription request from an other hub
   * Distribute content to subscribers (with support for authenticated content distribution)
-  [hcard](http://microformats.org/wiki/hcard):
   * Lookup and parse a hcard into a JSON object
   * Render an hcard from a JSON object
-  [activitystreams](http://activitystrea.ms/):
   * Fetch an atom feed with activitystream content and return a JSON representation of the stream. The JSON object is a valid activitystream JSON object.
   * Render an atom feed from an array of activities in JSON

What is missing:

-  [salmon](http://www.salmon-protocol.org/)
<commit_msg>Fixed markdown issues in README<commit_after>node-ostatus
============

An implementation of the [OStatus](http://ostatus.org) protocol stack for node.js

*** Ongoing development on the master branch until I reach a first stable 0.1 release ***

Copyright (C) 2010 <NAME> <<EMAIL>>

Install
-------

If you are using npm (the node packet manager), installing is as easy as:
    npm install ostatus


Dependencies
------------

If you are using this from source, you can install the dependencies using npm from the root of the source folder:
    npm bundle

Or you can install all dependencies manually:
* [node](http://nodejs.org/) v4+ is required, I'm developing against trunk.
* [node-o3-xml](https://github.com/ajaxorg/node-o3-xml/)
* [Mu](https://github.com/raycmorgan/Mu/tree/v2) the v2 branch

Documentation
-------------

The API is documented in the [wiki](http://github.com/eschnou/node-ostatus/wiki). 

Progress
--------

The following pieces of the protocol are implemented:

-  [webfinger](http://code.google.com/p/webfinger/): 
   * Lookup a user account and return the user meta in a JSON format
   * Rendering of host/user meta based on a JSON input object
-  [pubsubhubbub](http://code.google.com/p/pubsubhubbub/): 
   * Subscribe/Unsubscribe to a topic on another hub
   * Verify a subscription request from an other hub
   * Distribute content to subscribers (with support for authenticated content distribution)
-  [hcard](http://microformats.org/wiki/hcard):
   * Lookup and parse a hcard into a JSON object
   * Render an hcard from a JSON object
-  [activitystreams](http://activitystrea.ms/):
   * Fetch an atom feed with activitystream content and return a JSON representation of the stream. The JSON object is a valid activitystream JSON object.
   * Render an atom feed from an array of activities in JSON

What is missing:

-  [salmon](http://www.salmon-protocol.org/)

{'fraction_non_alphanumeric': 0.11834789515488484, 'fraction_numerical': 0.005824728620598359, 'mean_word_length': 3.529976019184652, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1808229', 'n_tokens_mistral': 1118, 'n_tokens_neox': 1083, 'n_words': 435}