mirror of
https://github.com/dnote/dnote
synced 2026-03-18 00:09:56 +01:00
Document
This commit is contained in:
parent
925ea88e3f
commit
216fb74fa7
2 changed files with 49 additions and 0 deletions
43
README.md
43
README.md
|
|
@ -12,6 +12,45 @@ On macOS, or Linux, run:
|
|||
|
||||
On Windows, download [binary](https://github.com/dnote-io/cli/releases)
|
||||
|
||||
## Usage
|
||||
|
||||
Dnote categorizes your **notes** by **books**.
|
||||
|
||||
All your books and notes are stored in `$HOME/.dnote` as a YAML file.
|
||||
|
||||
In the future, you can sync your note with the Dnote server and set up digest notifications to reinforce your learning.
|
||||
|
||||
### Commands
|
||||
|
||||
**dnote use [book name]**
|
||||
|
||||
Change the book to write your note in.
|
||||
|
||||
e.g.
|
||||
|
||||
dnote use linux
|
||||
|
||||
**dnote new "[note]"**
|
||||
|
||||
Write a new note under the current book.
|
||||
|
||||
e.g.
|
||||
|
||||
dnote new "set -e instructs bash to exit immediately if any command has non-zero exit status"
|
||||
|
||||
**dnote books**
|
||||
|
||||
List all the books that you created
|
||||
|
||||
e.g.
|
||||
|
||||
$ dnote books
|
||||
javascript
|
||||
* linux
|
||||
tmux
|
||||
css
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
* [Website](https://dnote.io)
|
||||
|
|
@ -19,3 +58,7 @@ On Windows, download [binary](https://github.com/dnote-io/cli/releases)
|
|||
## License
|
||||
|
||||
MIT
|
||||
|
||||
-------
|
||||
|
||||
> Made by [sung](https://sungwoncho.io)
|
||||
|
|
|
|||
6
main.go
6
main.go
|
|
@ -268,12 +268,18 @@ func checkUpdates() error {
|
|||
return nil
|
||||
}
|
||||
|
||||
func heartbeat() {
|
||||
http.Get("http://api.dnote.io/heartbeat")
|
||||
}
|
||||
|
||||
func main() {
|
||||
err := initDnote()
|
||||
check(err)
|
||||
err = checkUpdates()
|
||||
check(err)
|
||||
|
||||
heartbeat()
|
||||
|
||||
if len(os.Args) < 2 {
|
||||
fmt.Println("Dnote - Spontaneously capture new engineering lessons\n")
|
||||
fmt.Println("Commands:")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue