Skip to content
Permalink
Browse files

Update README

  • Loading branch information
nickolasburr committed Feb 8, 2018
1 parent c98321f commit 2e1fec758af10cd5634bf63e9e8142e79dcef45c
Showing with 17 additions and 8 deletions.
  1. +17 −8 README.md
@@ -2,17 +2,26 @@

`git-stashd` is an autostashing daemon for Git.

## How it works
## Table of Contents

`git-stashd` brings autosave functionality to Git. By using the stashing functionality built into Git, `git-stashd` stores the modified contents of a dirty worktree in a stash, which you can checkout, commit, or discard at a later point.
- [Description](#description)
- [Installation](#installation)
+ [Homebrew](#homebrew)
+ [Manual](#manual)
- [Options](#options)
- [Examples](#examples)

## Description

By utilizing the stashing functionality built into Git, `git-stashd` stores the modified contents of a dirty worktree in a stash, which you can checkout, commit, or discard at a later point.

## Installation

You can install `git-stashd` via Homebrew or manually. See the [tap repository](https://github.com/nickolasburr/homebrew-pfa) for tap-specific information.
You can install `git-stashd` via Homebrew or manually.

### Homebrew

```shell
```
brew tap nickolasburr/pfa
brew install git-stashd
```
@@ -21,7 +30,7 @@ brew install git-stashd

By default, `git-stashd` is installed to /usr/local/bin. You can set the `prefix` variable when running `make` to specify an alternate install location.

```shell
```
make
make install
```
@@ -38,19 +47,19 @@ make install

**Start daemon for repository `~/projects/example`**

```shell
```
# You can omit --path ~/projects/example, if currently in the ~/projects/example directory.
git stashd --path ~/projects/example
```

**Start daemon for repository `~/projects/example` with an interval of 30 seconds**

```shell
```
git stashd --path ~/projects/example --interval 30
```

**Start daemon in foreground for repository `~/projects/example` with an interval of 5 minutes**

```shell
```
git stashd --foreground --path ~/projects/example --interval 300
```

0 comments on commit 2e1fec7

Please sign in to comment.
You can’t perform that action at this time.