mirror of https://github.com/fmartingr/shiori.git
Update readme
This commit is contained in:
Radhi Fadlillah
parent
5b0f6014f3
commit
dff8e31370
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2018 Radhi
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
107
README.md
107
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Shiori
|
||||
|
||||
Shiori is a simple bookmarks manager written in Go language. You can use it as command line application (like [`buku`](https://github.com/jarun/Buku)) or as web application (like [Pocket](https://getpocket.com//) or [Pinterest](https://www.pinterest.com/)). This application is distributed as a single binary, which make it can be installed and used easily.
|
||||
Shiori is a simple bookmarks manager written in Go language. Intended as a simple clone of [Pocket](https://getpocket.com//). You can use it as command line application or as web application. This application is distributed as a single binary, which make it can be installed and used easily.
|
||||
|
||||
|
||||
|
||||
|
|
@ -9,6 +9,7 @@ Shiori is a simple bookmarks manager written in Go language. You can use it as c
|
|||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Examples](#examples)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
|
|
@ -56,6 +57,110 @@ Flags:
|
|||
Use "shiori [command] --help" for more information about a command.
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
1. Save new bookmark with tags "nature" and "climate-change".
|
||||
|
||||
```
|
||||
shiori add https://grist.org/article/let-it-go-the-arctic-will-never-be-frozen-again/ -t nature,climate-change
|
||||
```
|
||||
|
||||
2. Print all saved bookmarks.
|
||||
|
||||
```
|
||||
shiori print
|
||||
```
|
||||
|
||||
2. Print bookmarks with index 1 and 2.
|
||||
|
||||
```
|
||||
shiori print 1 2
|
||||
```
|
||||
|
||||
3. Search bookmarks that contains "sqlite" in its title, excerpt, url or content.
|
||||
|
||||
```
|
||||
shiori search sqlite
|
||||
```
|
||||
|
||||
4. Search bookmarks with tag "nature".
|
||||
|
||||
```
|
||||
shiori search -t nature
|
||||
```
|
||||
|
||||
5. Delete all bookmarks.
|
||||
|
||||
```
|
||||
shiori delete
|
||||
```
|
||||
|
||||
6. Delete all bookmarks with tag "nature".
|
||||
|
||||
```
|
||||
shiori delete $(shiori search -t nature -i)
|
||||
```
|
||||
|
||||
7. Update all bookmarks' data and content.
|
||||
|
||||
```
|
||||
shiori update
|
||||
```
|
||||
|
||||
8. Update bookmark in index 1.
|
||||
|
||||
```
|
||||
shiori update 1
|
||||
```
|
||||
|
||||
9. Change title and excerpt from bookmark in index 1.
|
||||
|
||||
```
|
||||
shiori update 1 -i "New Title" -e "New excerpt"
|
||||
```
|
||||
|
||||
10. Add tag "future" and remove tag "climate-change" from bookmark in index 1.
|
||||
|
||||
```
|
||||
shiori update 1 -t future,-climate-change
|
||||
```
|
||||
|
||||
11. Import bookmarks from HTML Netscape Bookmark file.
|
||||
|
||||
```
|
||||
shiori import exported-from-firefox.html
|
||||
```
|
||||
|
||||
12. Export saved bookmarks to HTML Netscape Bookmark file.
|
||||
|
||||
```
|
||||
shiori export target.html
|
||||
```
|
||||
|
||||
13. Open all saved bookmarks in browser.
|
||||
|
||||
```
|
||||
shiori open
|
||||
```
|
||||
|
||||
14. Open text cache of bookmark in index 1.
|
||||
|
||||
```
|
||||
shiori open 1 -c
|
||||
```
|
||||
|
||||
15. Serve web app in port 9000.
|
||||
|
||||
```
|
||||
shiori serve -p 9000
|
||||
```
|
||||
|
||||
16. Create new account for login to web app.
|
||||
|
||||
```
|
||||
shiori account add username
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Shiori is distributed using [MIT license](https://choosealicense.com/licenses/mit/), which means you can use and modify it however you want. However, if you make an enchancement for it, if possible, please send the pull request.
|
||||
|
|
|
|||
Loading…
Reference in New Issue