forked from go-shiori/shiori
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
002f755
commit 63070d1
Showing
3 changed files
with
90 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Shiori | ||
|
||
[![Go Report Card](https://goreportcard.com/badge/github.com/go-shiori/shiori)](https://goreportcard.com/report/github.com/go-shiori/shiori) | ||
[![Donate](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.me/RadhiFadlillah) | ||
[![Donate](https://img.shields.io/badge/donate-Ko--fi-brightgreen)](https://ko-fi.com/radhifadlillah) | ||
|
||
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. | ||
|
||
![Screenshot](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/cover.png) | ||
|
||
## 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 sqlite3 and MySQL as its database. | ||
- Where possible, by default `shiori` will parse the readable content and create an offline archive of the webpage. | ||
|
||
![Compariosn of reader mode and archive mode](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/comparison.png) | ||
|
||
## 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). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.