ikr/README.md

IKnowRice - easily backup/share/restore your WM/DE configs

ikr
===

Backup & restore your desktop configs.

Inspired by RiceDB.

Installation
------------

`sudo npm install -g ikr`

Usage
-----

First you'll have to configure ikr. Just run `ikr config` and then edit the config file (`~/.ikrrc`).


**Other commands:**

* `ikr backup target_file.zip`
* `ikr restore source_file.zip` -- **WARNING!** may cause data loss (overwrites your files with files from archive)

Example config file
-------------------

**The format may change in future releases**

    {
        "files": [
            {
                "path": "~/.Xdefaults",
                "type": "file"
            },
            {
                "path": "~/.Xresources",
                "type": "file"
            },
            {
                "path": "~/.xprofile",
                "type": "file"
            },
            {
                "path": "~/.xinitrc",
                "type": "file"
            },
            {
                "path": "~/.config/awesome",
                "type": "directory"
            }
        ]
    }