fmartingr
/
shiori
mirror of https://github.com/fmartingr/shiori.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
406 Commits 1 Branch 3 Tags 46 MiB
Go 93.7%
JavaScript 5.7%
Less 0.4%
HTML 0.2%
Go to file
Felipe M a0c56686a9
docs: moved wiki inside docs folder 		2022-01-26 22:50:16 +01:00
.githooks Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.github Remove Radhi's accounts from GitHub Sponsors 2020-08-06 22:15:45 +02:00
cmd fix: asset generator 2022-01-26 22:46:46 +01:00
docs docs: moved wiki inside docs folder 2022-01-26 22:50:16 +01:00
internal chore: removed logger 2022-01-26 22:46:19 +01:00
.gitignore feat: updated dependencies 2022-01-23 11:46:14 +01:00
CODE_OF_CONDUCT.md Update links and email addresses 2020-08-06 22:26:59 +02:00
Dockerfile bug: Docker build 2020-08-11 22:51:30 +00:00
LICENSE docs: updated license 2022-01-23 13:03:46 +01:00
Makefile chore: added makefile 2022-01-23 11:46:35 +01:00
Procfile Added Heroku deploy. Fixed go-shiori/shiori#45 2019-09-25 13:45:08 +03:00
README.md docs: moved wiki inside docs folder 2022-01-26 22:50:16 +01:00
app.json Revert "Restructure build files" 2019-09-26 16:25:19 +07:00
go.mod feat: updated dependencies 2022-01-23 11:46:14 +01:00
go.sum feat: updated dependencies 2022-01-23 11:46:14 +01:00
modd.conf fix: updated modd configuration 2022-01-23 12:59:31 +01:00

README.md

Shiori

CI Go Report Card

Shiori is a simple bookmarks/read-later manager written in the Go language intended as a simple clone of Pocket/instapapter. 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 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.

Documentation

All documentation is available under the docs folder. If you think there is incomplete or incorrect information, feel free to submit a patch.

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.