Skip to content

Commit

Permalink
added readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
lucas-clemente committed Oct 24, 2014
1 parent 71676e5 commit a5362c5
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 1 deletion.
5 changes: 5 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Goldfish Changelog

## 0.1.0 (2014-10-24)

- Initial release
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,48 @@
# goldfish
# Goldfish

A personal wiki / notes blend inspired by Evernote and gollum, based on git.

## Features

- Just files on your disk. Actually, a git repo on your disk.
- A server and a web-frontend, all in a single executable. The server manages files, your browser displays them.
- Files are markdown with some extensions:
- LaTeX `$$\latex$$` or, if you want it on its own line, `\[ \latex \]`)
- Easier links `[[foo]]`, also works for images `[[foo.png]]`
- If you change files on disk, they are automagically committed and updated in your browser.

Future features:

- Search
- Auto-push
- Linux / Windows support

## Screenshot time!

![](screen.png)

Code for the page:

```markdown
# Demo Page

## Markdown

Things you can do:

- Make _important_ notes
- Write in __strong__ letters

## Equations

Both $$e^\text{inline}$$ and in display mode:

\[
e^{i \pi} = -1
\]

## Images

[[fish.png]]

```
Binary file added screen.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a5362c5

Please sign in to comment.