Skip to content

Commit

Permalink
Version 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bittersweet committed Dec 19, 2014
1 parent 466d72e commit 4c94475
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
4 changes: 4 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Notes Changelog

## 0.5.0

- Allow overriding of storage directory via `NOTESDIR`, thanks to @mongrelion.

## 0.4.0

- Opens editor with note name anyway if it doesn't exist yet.
Expand Down
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ Store your thoughts on all sorts of subjects and easily read them on the
commandline. I use it for CLI commands I don't use very often and keep
forgetting.

Currently it expects a `~/dotfiles/notes/` directory to store all the notes
but you can override this by setting the `$NOTESDIR` variable.
These are just simple textfiles for easy editting and portability.
It expects a `~/dotfiles/notes/` directory to store all the notes but you can
override this by setting the `$NOTESDIR` variable from within your `.profile`
for example.
The notes are stored as simple textfiles for easy editting and portability.

You can use # comments to explain the command, these will get colorized when
outputted, an example:
You can prepend a line with `#` to explain the command, these comments will get
colorized, an example:

```
# Show open files by PID
Expand All @@ -20,10 +21,9 @@ lsof -p $PID

## Installation

As it's in super early stage, you'll have to build it yourself. I'm hoping you
have Go already setup. If so, just clone, `go get`, and run `make` to build it
and move it to `/usr/local/bin/`, or `go build notes.go` and move it yourself to
a desired location.
You can download the [latest
release](https://github.com/bittersweet/notes/releases) or build it yourself of
course.

## Usage

Expand All @@ -32,8 +32,7 @@ a desired location.
`notes edit [note]` edits
`notes new [name]` creates a new note

Editting and creating new notes uses $EDITOR or vi if that is not set.

Editting and creating new notes uses `$EDITOR` or `vi` in case that is not set.

## Testing

Expand Down
2 changes: 1 addition & 1 deletion notes.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ func getNotesDir() string {
func main() {
app := cli.NewApp()
app.Name = "notes"
app.Version = "0.4.0"
app.Version = "0.5.0"
app.Usage = "Store your thoughts on all sorts of subjects"
app.Action = func(c *cli.Context) {
note := c.Args().First()
Expand Down

0 comments on commit 4c94475

Please sign in to comment.