fmartingr
/
shiori
mirror of https://github.com/fmartingr/shiori.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
389 Commits 1 Branch 3 Tags 46 MiB
Go 93.7%
JavaScript 5.7%
Less 0.4%
HTML 0.2%
Go to file
Dean Jackson c5fd20040a Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.githooks Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.github Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
docs Tidy up docs files 2019-09-26 06:58:47 +07:00
internal Exit with non-zero status when add fails 2020-08-06 20:03:25 +02:00
.gitignore Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
CODE_OF_CONDUCT.md Add code of conduct 2019-09-23 22:16:49 +07:00
Dockerfile Revert "Restructure build files" 2019-09-26 16:25:19 +07:00
LICENSE Update LICENSE 2019-01-06 17:00:20 +07:00
Procfile Added Heroku deploy. Fixed go-shiori/shiori#45 2019-09-25 13:45:08 +03:00
README.md Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
app.json Revert "Restructure build files" 2019-09-26 16:25:19 +07:00
assets-generator.go Initial new web interfaces 2019-05-27 17:01:53 +07:00
go.mod Move warc to another package 2019-10-09 20:10:12 +07:00
go.sum Move warc to another package 2019-10-09 20:10:12 +07:00
main.go Initial PostgreSQL support 2019-09-24 19:59:25 +03:00
modd.conf Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00

README.md

Shiori

CI Go Report Card Docker Image Deploy Heroku

This project is now maintained by Dean Jackson (@deanishe). The awesome original author, @RadhiFadlillah, unfortunately no longer has the time (see #256), and I am honoured to take over stewardship of such a fantastic application.

Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of 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.

Screenshot

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.
  • Support for sqlite3, PostgreSQL and MySQL as its database.
  • Where possible, by default shiori will parse the readable content and create an offline archive of the webpage.
  • [BETA] web extension support for Firefox and Chrome.

Comparison of reader mode and archive mode

Documentation

All documentation is available in wiki. If you think there is incomplete or incorrect information, feel free to edit it.

License

Shiori is distributed under the terms of the MIT license, 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.