diff --git a/README.md b/README.md index 284b2aa478..c4f0c8d59c 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ All documentation is available in the [docs folder][documentation]. If you think 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. +[getting started]: https://github.com/go-shiori/shiori/blob/master/docs/getting-started.md [documentation]: https://github.com/go-shiori/shiori/blob/master/docs/index.md [mit]: https://choosealicense.com/licenses/mit/ [web-extension]: https://github.com/go-shiori/shiori-web-ext diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000000..2cff6a46d0 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,29 @@ +# Getting Started + +In the beginning, it is necessary to execute the Shiori server locally. There are various methods available for this purpose; however, we will concentrate on employing the least intrusive option, which involves utilizing containers. + +- Launch the Shiori server using the Command Line Interface (CLI): + +``` +mkdir -p ~/.config/shiori/ +docker run -d -v ${HOME}/.config/shiori:/shiori -p 8080:8080 ghcr.io/go-shiori/shiori:latest +``` + +- Subsequently, you can access the homepage at the [here](http:/127.0.0.1:8080). Please use the following credentials to log in: `shiori/gopher.` + +- Within the web application, you can add a new bookmark by following the steps depicted in the screenshots below: + +![gs-01](./screenshots/17-gs-add-bookmark.png) +![gs-02](./screenshots/18-gs-add-bookmark.png) +![gs-03](./screenshots/19-gs-add-bookmark.png) + +This action will generate a new entry, as illustrated in the final screenshot. + +- Following this step, you should proceed to select the __Update Archive__ button in order to initiate the process of creating a local copy of the page. + +![gs-04](./screenshots/20-gs-add-bookmark.png) +![gs-05](./screenshots/21-gs-add-bookmark.png) + +- At this point, you will be able to observe your downloaded bookmark, which has been successfully stored locally. + +![gs-06](./screenshots/22-gs-add-bookmark.png) diff --git a/docs/index.md b/docs/index.md index 295d600240..ec3c976e59 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,7 @@ Shiori is a simple bookmarks manager written in Go language. Intended as a simpl ## Resources +- [Getting Started](./Getting-Started.md) - [API](./API.md) (Deprecated) - [APIv1](./APIv1.md) ([What is this?](https://github.com/go-shiori/shiori/issues/640)) - [Contributing](./Contribute.md) diff --git a/docs/screenshots/17-gs-add-bookmark.png b/docs/screenshots/17-gs-add-bookmark.png new file mode 100644 index 0000000000..e48bfd55f2 Binary files /dev/null and b/docs/screenshots/17-gs-add-bookmark.png differ diff --git a/docs/screenshots/18-gs-add-bookmark.png b/docs/screenshots/18-gs-add-bookmark.png new file mode 100644 index 0000000000..9c9d956692 Binary files /dev/null and b/docs/screenshots/18-gs-add-bookmark.png differ diff --git a/docs/screenshots/19-gs-add-bookmark.png b/docs/screenshots/19-gs-add-bookmark.png new file mode 100644 index 0000000000..da27b03cac Binary files /dev/null and b/docs/screenshots/19-gs-add-bookmark.png differ diff --git a/docs/screenshots/20-gs-add-bookmark.png b/docs/screenshots/20-gs-add-bookmark.png new file mode 100644 index 0000000000..dfd2051cd3 Binary files /dev/null and b/docs/screenshots/20-gs-add-bookmark.png differ diff --git a/docs/screenshots/21-gs-add-bookmark.png b/docs/screenshots/21-gs-add-bookmark.png new file mode 100644 index 0000000000..47008e2fa0 Binary files /dev/null and b/docs/screenshots/21-gs-add-bookmark.png differ diff --git a/docs/screenshots/22-gs-add-bookmark.png b/docs/screenshots/22-gs-add-bookmark.png new file mode 100644 index 0000000000..8257d41d44 Binary files /dev/null and b/docs/screenshots/22-gs-add-bookmark.png differ