fmartingr
/
shiori
mirror of https://github.com/fmartingr/shiori.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
shiori/README.md

34 lines
2.4 KiB
Markdown
Raw Normal View History

Add readme
2019-08-27 09:04:57 +00:00
# Shiori
[![Go Report Card](https://goreportcard.com/badge/github.com/go-shiori/shiori)](https://goreportcard.com/report/github.com/go-shiori/shiori)
Update readme: add link to Docker
2019-09-21 14:10:31 +00:00
[![Docker Image](https://img.shields.io/static/v1?label=image&message=Docker&color=1488C6&logo=docker)](https://hub.docker.com/r/radhifadlillah/shiori)
Move heroku button to badge for consistency
2019-09-26 09:31:32 +00:00
[![Deploy Heroku](https://img.shields.io/static/v1?label=deploy&message=Heroku&color=430098&logo=heroku)](https://heroku.com/deploy)
Update readme: add link to Docker
2019-09-21 14:10:31 +00:00
[![Donate PayPal](https://img.shields.io/static/v1?label=donate&message=PayPal&color=00457C&logo=paypal)](https://www.paypal.me/RadhiFadlillah)
[![Donate Ko-fi](https://img.shields.io/static/v1?label=donate&message=Ko-fi&color=F16061&logo=ko-fi)](https://ko-fi.com/radhifadlillah)
Add readme
2019-08-27 09:04:57 +00: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.
Tidy up docs files
2019-09-25 23:58:47 +00:00
![Screenshot](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/cover.png)
Add readme
2019-08-27 09:04:57 +00: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.
Initial PostgreSQL support
2019-09-24 16:59:25 +00:00
- Support sqlite3, PostgreSQL and MySQL as its database.
Add readme
2019-08-27 09:04:57 +00:00
- Where possible, by default `shiori` will parse the readable content and create an offline archive of the webpage.
Update readme to include web extension
2019-09-05 10:31:44 +00:00
- [BETA] [web extension](https://github.com/go-shiori/shiori-web-ext) support for Firefox and Chrome.
Add readme
2019-08-27 09:04:57 +00:00
Tidy up docs files
2019-09-25 23:58:47 +00:00
![Comparison of reader mode and archive mode](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/readme/comparison.png)
Add readme
2019-08-27 09:04:57 +00:00
## Documentation
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.
## 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. If you like this project, please consider donating to me either via [PayPal](https://www.paypal.me/RadhiFadlillah) or [Ko-Fi](https://ko-fi.com/radhifadlillah).