2019-08-27 17:04:57 +08:00
# Shiori
2020-08-07 02:15:50 +08:00
[](https://github.com/go-shiori/shiori/actions?query=workflow%3ACI)
2019-08-27 17:04:57 +08:00
[](https://goreportcard.com/report/github.com/go-shiori/shiori)
2019-09-21 22:10:31 +08:00
[](https://hub.docker.com/r/radhifadlillah/shiori)
2019-09-26 17:31:32 +08:00
[](https://heroku.com/deploy)
2020-06-20 19:11:03 +08:00
2020-08-07 04:26:59 +08:00
**This project is now maintained by Dean Jackson (@deanishe).** The awesome original author, @RadhiFadlillah , unfortunately no longer has the time (see [#256][256]), and I am honoured to take over stewardship of such a fantastic application.
2019-08-27 17:04:57 +08:00
2020-08-07 04:26:59 +08:00
Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of [Pocket][pocket]. You can use it as a command line application or as a web application. This application is distributed as a single binary, which means it can be installed and used easily.
2019-08-27 17:04:57 +08:00
2020-08-07 04:26:59 +08:00
![Screenshot][screenshot]
2019-08-27 17:04:57 +08:00
## Features
- Basic bookmarks management i.e. add, edit, delete and search.
- Import and export bookmarks from and to Netscape Bookmark file.
- Import bookmarks from Pocket.
- Simple and clean command line interface.
- Simple and pretty web interface for those who don't want to use a command line app.
- Portable, thanks to its single binary format.
2019-10-05 06:40:41 +08:00
- Support for sqlite3, PostgreSQL and MySQL as its database.
2019-08-27 17:04:57 +08:00
- Where possible, by default `shiori` will parse the readable content and create an offline archive of the webpage.
2020-08-07 04:26:59 +08:00
- [BETA] [web extension][web-extension] support for Firefox and Chrome.
2019-08-27 17:04:57 +08:00
2020-08-07 04:26:59 +08:00
![Comparison of reader mode and archive mode][mode-comparison]
2019-08-27 17:04:57 +08:00
## Documentation
2020-08-07 04:26:59 +08:00
All documentation is available in the [wiki][wiki]. If you think there is incomplete or incorrect information, feel free to edit it.
2019-08-27 17:04:57 +08:00
## License
2020-08-07 04:26:59 +08:00
Shiori is distributed under the terms of the [MIT license][mit], which means you can use it and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.
[wiki]: https://github.com/go-shiori/shiori/wiki
[mit]: https://choosealicense.com/licenses/mit/
[web-extension]: https://github.com/go-shiori/shiori-web-ext
[screenshot]: https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/cover.png
[mode-comparison]: https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/comparison.png
[pocket]: https://getpocket.com/
[256]: https://github.com/go-shiori/shiori/issues/256
