github.com/soulteary/pocket-bookcase@v0.0.0-20240428065142-0b5a9a0fc98a/README.md (about)

     1  # Shiori
     2  
     3  [![IC](https://github.com/soulteary/pocket-bookcase/actions/workflows/push.yml/badge.svg?branch=master)](https://github.com/soulteary/pocket-bookcase/actions/workflows/push.yml)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/soulteary/pocket-bookcase)](https://goreportcard.com/report/github.com/soulteary/pocket-bookcase)
     5  [![#shiori-general:matrix.org](https://img.shields.io/badge/matrix-%23shiori-orange)](https://matrix.to/#/#shiori:matrix.org)
     6  [![Containers](https://img.shields.io/static/v1?label=Container&message=Images&color=1488C6&logo=docker)](https://github.com/soulteary/pocket-bookcase/pkgs/container/shiori)
     7  
     8  **Check out our latest [Announcements](https://github.com/soulteary/pocket-bookcase/discussions/categories/announcements)**
     9  
    10  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.
    11  
    12  ![Screenshot][screenshot]
    13  
    14  ## Features
    15  
    16  - Basic bookmarks management i.e. add, edit, delete and search.
    17  - Import and export bookmarks from and to Netscape Bookmark file.
    18  - Import bookmarks from Pocket.
    19  - Simple and clean command line interface.
    20  - Simple and pretty web interface for those who don't want to use a command line app.
    21  - Portable, thanks to its single binary format.
    22  - Support for sqlite3, PostgreSQL and MySQL as its database.
    23  - Where possible, by default `shiori` will parse the readable content and create an offline archive of the webpage.
    24  - [BETA] [web extension][web-extension] support for Firefox and Chrome.
    25  
    26  ![Comparison of reader mode and archive mode][mode-comparison]
    27  
    28  ## Documentation
    29  
    30  All documentation is available in the [docs folder][documentation]. If you think there is incomplete or incorrect information, feel free to edit it by submitting a pull request.
    31  
    32  ## License
    33  
    34  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.
    35  
    36  [documentation]: https://github.com/soulteary/pocket-bookcase/blob/master/docs/index.md
    37  [mit]: https://choosealicense.com/licenses/mit/
    38  [web-extension]: https://github.com/soulteary/pocket-bookcase-web-ext
    39  [screenshot]: https://raw.githubusercontent.com/soulteary/pocket-bookcase/master/docs/readme/cover.png
    40  [mode-comparison]: https://raw.githubusercontent.com/soulteary/pocket-bookcase/master/docs/readme/comparison.png
    41  [pocket]: https://getpocket.com/
    42  [256]: https://github.com/soulteary/pocket-bookcase/issues/256