shiori/README.md

28 lines
1.8 KiB
Markdown
Raw Normal View History

2018-02-26 21:02:12 +08:00
# Shiori
2018-03-05 15:37:50 +08:00
[![Travis CI](https://travis-ci.org/RadhiFadlillah/shiori.svg?branch=master)](https://travis-ci.org/RadhiFadlillah/shiori)
[![Go Report Card](https://goreportcard.com/badge/github.com/radhifadlillah/shiori)](https://goreportcard.com/report/github.com/radhifadlillah/shiori)
2018-03-10 21:47:34 +08:00
[![Docker Build Status](https://img.shields.io/docker/build/radhifadlillah/shiori.svg)](https://hub.docker.com/r/radhifadlillah/shiori/)
2018-03-05 15:37:50 +08:00
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 means it can be installed and used easily.
2018-02-26 21:02:12 +08:00
2018-05-27 23:08:43 +08:00
![Screenshot](https://raw.githubusercontent.com/RadhiFadlillah/shiori/master/screenshot/pc-grid.png)
2018-02-26 21:02:12 +08:00
## Features
- Simple and clean command line interface.
2018-02-26 21:02:12 +08:00
- Basic bookmarks management i.e. add, edit and delete.
- Search bookmarks by their title, tags, url and page content.
2018-02-26 21:02:12 +08:00
- Import and export bookmarks from and to Netscape Bookmark file.
- Portable, thanks to its single binary format and sqlite3 database
- Simple web interface for those who don't want to use a command line app.
- Where possible, by default `shiori` will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page.
2018-02-26 21:02:12 +08:00
2018-07-02 12:33:21 +08:00
## Documentation
2018-02-27 11:53:55 +08:00
2018-07-02 12:33:21 +08:00
All documentation is available in [wiki](https://github.com/RadhiFadlillah/shiori/wiki). If you think there are incomplete or incorrect information, feels free to edit it.
2018-02-27 11:53:55 +08:00
2018-02-26 21:02:12 +08:00
## 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 enhancement for it, if possible, please send a pull request.