Skip to content

Commit

Permalink
add usecase
Browse files Browse the repository at this point in the history
  • Loading branch information
hiroara committed Mar 21, 2019
1 parent 81cb9c5 commit f14dc2a
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,28 @@

![Bunshin no Jutsu](./images/ninja.svg)

Bunshin-no-Jutsu is a CLI to make copies of your files.
Bunshin-no-Jutsu is a CLI to make complete copies of your files.
You can use this for making backup :)

For example, you can copy your project under a directory which syncs with Dropbox.

This tool works as a configuration-oriented tool.
The name of the configuration file is `.makimono.yml` :scroll:

## Usecase

### Working with Dropbox

For example, you can copy your project under a directory which syncs with Dropbox.

Dropbox is sometimes heavy especially when we have many files, and doing many writing/deleting files.
(e.g. Developing a nodejs project under Dropbox directory and build it)

In this case, we can reduce the waste of machine resources by using Bunshin-no-Jutsu.

This can be done by syncing two directories:

- `~/dev/some-project`: Working directory
- `~/Dropbox/dev/some-project`: Backup directory to sync with Dropbox

## Getting Started

### Installation with build
Expand Down

0 comments on commit f14dc2a

Please sign in to comment.