Update readme.

This commit is contained in:
kor 2018-07-24 00:37:55 +12:00
parent 57a895c0f0
commit f478a00897

View File

@ -1,6 +1,4 @@
# Memex
Memex is a simple open-source bookmarks and notes application to help with storage and overview
**Memex** is a simple open-source bookmarks and notes application to help with storage and overview
[Live web version here](https://kormyen.github.io/memex/)
@ -19,19 +17,33 @@ Memex supports:
- quotes
- terms
- tags
- filting
- filtering
## Data
#### Data
Data is stored in a human-readable, flat-file database called [Indental](https://wiki.xxiivv.com/#indental) which is made by Devine Lu Linvega
- [docs/content/data.ndtl](docs/content/data.ndtl)
## Dependencies
#### Development
```
git clone git@github.com:kormyen/memex.git
cd memex
npm install
npm start
```
#### Dependencies
- App builder: [Electron](https://electronjs.org/)
- Database parser: [Indental](https://wiki.xxiivv.com/#indental)
- Template parser: [Runic](https://wiki.xxiivv.com/#runic)
- Grid layout: [Masonry](https://masonry.desandro.com/)
Thanks to Devine Lu Linvega ([Oscean](https://github.com/XXIIVV/Oscean)), Josh Avanier ([Log](https://github.com/joshavanier/log)), Rekka Bell ([kokorobot](https://github.com/rekkabell/kokorobot)) and Alexey Botkov ([Legacy](https://github.com/nomand/Legacy))
Thanks to Devine Lu Linvega ([Oscean](https://github.com/XXIIVV/Oscean)), Josh Avanier ([Log](https://github.com/joshavanier/log)), Rekka Bell ([kokorobot](https://github.com/rekkabell/kokorobot)) and Alexey Botkov ([Legacy](https://github.com/nomand/Legacy))
---
Hamish MacDonald
**[Twitter](https://twitter.com/kormyen)** · **[Home](https://kor.nz)**