Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
domenkozar committed Dec 8, 2013
1 parent cbc60dc commit c67e64f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
Collection of scripts to liberate your data from the cloud services.

[![Build Status](https://secure.travis-ci.org/iElectric/liberate-me.png?branch=master)](http://travis-ci.org/iElectric/liberate-me) [![Coverage Status](https://coveralls.io/repos/iElectric/liberate-me/badge.png)](https://coveralls.io/r/iElectric/liberate-me) [![NPM version](https://badge.fury.io/js/liberate-me.png)](http://badge.fury.io/js/liberate-me)

Collection of scripts to liberate your data from the cloud services. Serves two purposes:

- backup of your data in case of X
- offline access to your data

# Usage

$ npm install -g liberate-me
$ liberate-me dump-config > libme.json
$ $EDITOR libme.json
$ liberate-me libme.json target/

NOTE: Run incremental backup on target/
NOTE: After successful retrieval, run incremental backup job on `target/` directory.

# Supported services

Expand All @@ -18,8 +21,9 @@ NOTE: Run incremental backup on target/

# Contributing

- all configuration should be done in libme.json.sample and include commented example that ships with this repository
- all configuration should be done in `libme.json.sample` and include commented example that ships with this repository
- name of the backend needs to match config subsection
- test coverage

# TODO

Expand Down

0 comments on commit c67e64f

Please sign in to comment.