Skip to content

Commit 9a23a5f

Browse files
Improved readme
1 parent f1a6efd commit 9a23a5f

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

readme.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,26 @@ GoPage has been made with the goal of extreme simplicity and convenient extensib
3232
3333
## Features
3434

35-
* Full Theme Support from Installed Plugins
36-
* Custom Background Images
35+
* Install many plugins to expand the functionality of a saved Link Item.
36+
* Custom User-Defined categories for each Link Item.
37+
* Custom Background Images.
3738
* Searchable saved Link Items.
38-
* Filter saved Link Items based on user set categories.
39-
* Plugin Repo Page:
40-
* Ability to update Available Plugins
41-
* Install/Uninstall Existing Plugins
42-
* Link Health Page:
43-
* Alerts of Exact Duplicate Links
44-
* Alerts of Hostname Duplicate Links
39+
* Filter saved Link Item based on the category.
40+
* Link Health page to alert of Link Items with duplicate Links or matching Hostnames.
41+
* Each Link Item can have a custom colour, or different style applied.
42+
* Supports many types of HTTP logging, to assist in log aggregation.
43+
* Supports either private or public Robots file to prevent or encourage appearing in search engines.
4544
* GoPage supports many different languages, with contributions always welcome to improve them.
4645
* Arabic
4746
* Chinese (Traditional)
48-
* English
47+
* English
4948
* French
5049
* German
5150
* Japanese
5251
* Korean
5352
* Russian
5453
* Spanish (Mexico)
5554

56-
![Translations Progress](https://badges.awesome-crowdin.com/translation-15135739-498245.png)
57-
5855
## Installation
5956

6057
### Docker
@@ -65,14 +62,15 @@ The installation for Docker should be universal for Linux, and Windows, taking o
6562
* And run it using whatever Port you prefer, giving a name if you'd like, optionally setting the language.
6663

6764
````(bash)
68-
docker pull ghcr.io/confused-techie/gopage:0.4
65+
docker pull ghcr.io/confused-techie/gopage:0.5
6966
70-
docker run -p 7070:8080 -e LANG="en" --name GoPageServer ghcr.io/confused-techie/gopage:0.4
67+
docker run -p 7070:8080 --name GoPageServer ghcr.io/confused-techie/gopage:0.5
7168
````
7269

7370
* Please keep in mind the **7070** shown here can be whatever port you want the Docker Container Exposed on. Whereas **8080** is the default port the GoPage Server will listen to within the container.
7471

75-
* The `LANG` option is to set the GoPage Server Language. Ensuring to use the [ISO 639-1 two character language abbreviation.](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
72+
* GoPage supports additional variables that can be set. [Please refer to the documentation](docs/docker-environmentVariables.md).
73+
7674

7775
### Windows
7876

@@ -88,15 +86,17 @@ Once you've installed GoPage Dashboard you will be able to navigate to it like s
8886
http://SERVER-IP:PORT/
8987
````
9088

89+
If you haven't added any Link Items to GoPage you'll be greeted by the 'First Time Setup' window, helping with tips similar to whats found here. Otherwise feel free to give this a look over.
90+
9191
Once there you can get started by adding new Links by hitting 'Add New Item' and filling in the details on the next page.
9292

9393
* Friendly Name: Will be the name shown to you when you look at this Link.
9494
* Link: Of Course is the actual Link to navigate to.
9595
* Category: Is if you so choose a Category you can create for this link, to later on help you find it again. This section will suggest any previously created categories but can always be something new.
9696

97-
If you haven't installed any plugins at this point you can ignore the different Plugin Sections and hit 'Submit'
97+
If you haven't installed any plugins at this point you can ignore the 'Add Plugin' button and hit 'Submit'
9898

99-
Otherwise if you'd like to get started with some plugins to extend the functionality of GoPage you can navigate to Settings via the Gear Icon in the top left corner then hitting the GoTo button on the right side of the 'Plugin Repo' Listing under Tools.
99+
Otherwise if you'd like to get started with some plugins to extend the functionality of GoPage you can click 'Plugin Repo' in the top Header.
100100

101101
Or by navigating to:
102102

@@ -106,7 +106,7 @@ http://SERVER-IP:PORT/pluginrepo
106106

107107
Once here feel free to read through and explore the Plugins available and download them, which will then give you the ability to set them in the Plugin Fields of a New Link Item or while Editing a Link Item.
108108

109-
## Plugins Available by Default
109+
## Plugins Available
110110

111111
Many Plugins have already been created for GoPage and are available by default after installation.
112112

@@ -117,6 +117,7 @@ Many Plugins have already been created for GoPage and are available by default a
117117
* Light Theme: Simple Light Theme for those not loving the Dark Theme.
118118
* Exaggerator Theme: Exaggerator Theme... Just Colourful.
119119
* AQI Current: Get Air Quality Information at a glance. Via AirNow.gov.
120+
* Self Hosted Icons: Get self Hosted High Quality Icons alongside their links.
120121

121122
## [Contribute](docs/CONTRIBUTING.md)
122123

0 commit comments

Comments
 (0)