quenousimporte
/
bbn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
quenousimporte 2024-10-08 10:00:40 +02:00
parent 6fbc287759
commit f064242acf
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
readme.md
View File

@ -6,25 +6,22 @@ No javascript.
## Install
* Upload the files on a php server.
* Edit settings.php.sample.php and rename it to settings.php.
* Edit settings.php.sample and rename it to settings.php.
## Usage
| Home page | action with param | action with empty param | hotkey |
|------------------------|----------------------------------|-------------------------------|--------|
| search (default action)| full text search | reload home | alt-s |
| open | open if exists, or create | create with timestamp as title| alt-o |
| download | download all notes in a zip file | | alt-d |
| Home page | action | hotkey |
|-----------------------------|----------------------------------|--------|
| press enter in search field | full text search | alt-s |
| new | create new note | alt-o |
| download | download all notes in a zip file | alt-d |
| Note page | action with param | hotkey |
|------------------------|--------------------------|--------|
| home (default action) | save and back to home | alt-h |
|------------------------|--------------------------------|--------|
| home | save and back to home | alt-h |
| save | save | alt-s |
| preview | save and show markdown preview | alt-p |
| download | save and download as .md file | alt-d |
| delete | delete (rename as .del) | alt-d |
| Url params | action |
|------------------------|--------------------------|
| reindex | force notes reindex |
| open+param | same as button |
| search+param | same as button |
todo: url params