0.0.1 • Published 8 years ago

filebase v0.0.1

Weekly downloads
21
License
MIT
Repository
github
Last release
8 years ago

filebase NPM version Build Status

Git-backed file storage and versioning, with i18n support.

Install

Install with npm:

$ npm i filebase --save

Usage

This project is a WIP!

var filebase = require('filebase');

API

Filebase

Create an instance of Filebase with the given options

Params

  • options {Object}

Example

var filebase = new Filebase();

.set

Add file key with the given value

Params

  • key {String}
  • value {Object}

.get

Get file key

Params

  • key {String}
  • returns {Object}

.has

Return true if file key exists.

Params

  • key {String}
  • returns {Boolean}

.del

Delete file key

Params

  • key {String}

.initSync

Synchronously initialize a new git repository.

Example

filebase.initSync();

.save

Persist the filebase to disk.

Example

filebase.save();

Related projects

data-store: Easily get, set and persist config data. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.


This file was generated by verb on January 02, 2016.