Skip to content

Commit

Permalink
Update README, more documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
upvalue committed Nov 24, 2017
1 parent 811f889 commit d498ced
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
/coverage
*.sqlite
/docs/book
/_book
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Originally a Trello board, meditations simply keeps track of how often you compl
on them (optionally). It's fairly minimalist compared to more complex time management systems, and leave the structure
of your day entirely up to you. The goal of meditations is to get an objective, long-term view of how you are doing.

In addition, it has a journal that supports tagging and organizing entries by named categories.
In addition, it has a note-taking application that supports tagging and organizing entries by named categories.

![sample usage video](http://i.imgur.com/gmFSRK4.gif)

Expand All @@ -16,8 +16,8 @@ In addition, it has a journal that supports tagging and organizing entries by na
# Manual

For information on how to use Meditations as well as some documentation of its architecture, see
the manual: [HTML](https://rawgit.com/ioddly/meditations/master/docs/manual.html) |
[org](docs/manual.org) | `yarn run manual-open` from the command line to view your local copy.
[the documentation](https://ioddly.github.io/meditations). Also available in your local install
under the `docs` directory.

## Running from command line

Expand Down
7 changes: 4 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# meditations

[Meditations on GitHub](https://github.com/ioddly/meditations)
[Live Demo](https://meditations.upvalue.io)
## [Meditations on GitHub](https://github.com/ioddly/meditations)
## [Live Demo](https://meditations.upvalue.io)
## [Built by upvalue()](https://upvalue.io)

meditations is an application for tracking life progress that builds on the principles of habit
formation.
Expand All @@ -12,7 +13,7 @@ time management systems, and leave the structure of your day entirely up to you.
meditations is to get an objective, long-term view of how you are doing.

It's currently divided into two separate pieces of functionality: Habits (a todo list) and
Journal (a journal, go figure).
Notes (for note taking, go figure).

## Browser support

Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@
"test-backend": "godep go test -v ./backend --cover",
"test-frontend": "./node_modules/.bin/jest",
"test": "yarn run test-frontend && yarn run test-backend",
"test-frontend-coverage": "./node_modules/.bin/jest --coverage",
"manual-build": "emacs docs/manual.org --batch -f org-html-export-to-html",
"manual-open": "xdg-open docs/manual.html"
"test-frontend-coverage": "./node_modules/.bin/jest --coverage"
},
"jest": {
"moduleFileExtensions": [
Expand Down

0 comments on commit d498ced

Please sign in to comment.