Mercurial > hg > Members > anatofuz > growsync

annotate README.md @ 15:0dc44ee170b4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mkdir
author anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
date Sun, 03 Jan 2021 08:46:08 +0900
parents 3032e9f78e4b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 growsync
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
2 =======
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
3
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
4 [![Test Status](https://github.com/AnaTofuZ/growsync/workflows/test/badge.svg?branch=master)][actions]
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 [![Coverage Status](https://coveralls.io/repos/AnaTofuZ/growsync/badge.svg?branch=master)][coveralls]
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
6 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 [![GoDoc](https://godoc.org/github.com/AnaTofuZ/growsync?status.svg)][godoc]
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
8
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 [actions]: https://github.com/AnaTofuZ/growsync/actions?workflow=test
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
10 [coveralls]: https://coveralls.io/r/AnaTofuZ/growsync?branch=master
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 [license]: https://github.com/AnaTofuZ/growsync/blob/master/LICENSE
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 [godoc]: https://godoc.org/github.com/AnaTofuZ/growsync
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
13
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 growsync short description
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
15
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
16 ## Synopsis
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
17
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 ```go
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
19 // simple usage here
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
20 ```
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
21
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
22 ## Description
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
23
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
24 ## Installation
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
25
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
26 ```console
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 % go get github.com/AnaTofuZ/growsync
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
28 ```
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
29
3
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
30 ## CONFFILE
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
31
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
32 `$HOME/.config/growsync/config.yaml`
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
33
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
34 ```yaml
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
35 growi_url: https://growi.cr.ie.u-ryukyu.ac.jp
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
36 user_name: AnaTofuZ
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
37 token: hogehoge
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
38 local_root: /Users/anatofuz/Documents/cr-growi
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
39 daily_path: /user/anatofuz/note
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
40 ```
3032e9f78e4b add new cmd
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
41
0
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
42 ## Author
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
43
c0a01cfbf234 init project
anatofuz <anatofuz@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
44 [AnaTofuZ](https://github.com/AnaTofuZ)