hatena-tools v0.0.1
hatena-tools-nodejs
Hatena-tools, originally created in Python 2.7 by Peder Bergebakken Sundt, ported to NodeJS. Not ready for use.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisities
You'll need NodeJS (if you've got this far and don't have this, give up for your own sake) - the code has only been tested on v4.6.0. This project uses dependencies added with Facebook's Yarn, but also requires npm. The following packages are required:
validate.js
path
Installing
One the package has been included you can use the tools provided to manipulate PPM, UGO, and NTFT data. For example, to read a .UGO.json file and return a UGO file, you could do the following:
ugo = require('hatena-tools');
[...]
ugo.readJSON('foo.UGO.json');
Running the tests
Just runnpm test
:)
Deployment
This software isn't production-ready yet and should not be used.
Versioning
We will use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Peder Sundt - Initial work - Hatenatools
- Dylan Myers - Port author
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details. This is possible despite the Python version being licensed under AGPL3 because it does not derive any of its codebase from the Python original.
Acknowledgments
- Thanks to Peder, James, Austin and the Flipnote Collective
- ReadMe template by
8 years ago