Skip to content

Commit af3cbb0

Browse files
committed
Update readme
1 parent 2e3e01f commit af3cbb0

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,41 @@
11
FLibGoLite - Just enough for free OPDS
22
===
33

4-
__FLibGoLite__ is easy to use home library OPDS server you can install on your PC, NAS or server.
4+
__FLibGoLite__ is an easy-to-install and resource-friendly OPDS service written in pure Go.
55

66
__Detailed multilingual guides are available [here](https://vinser.github.io/flibgolite-docs/)__
7-
### CURRENT STABLE RELEASE v2.2.0
7+
### CURRENT STABLE RELEASE v2.2.1
8+
9+
__FLibGoLite__ main features:
10+
- Support for FB2 (separate files and zip archives), EPUB files.
11+
- Ability to convert FB2 to EPUB when downloading a book to a reader.
12+
- Multiplatform: Windows, MacOS, Linux. Easy to assemble for NAS under FreeBSD
13+
- Self-sufficient - does not require the installation of any additional libraries or applications.
14+
15+
#### Briefly how to use FLibGoLite.
16+
17+
You need:
18+
19+
1. PC, NAS or server with Windows, MacOS or Linux operating system.
20+
2. A reader (device or application) that can work with OPDS catalogs and supports FB2 or EPUB book formats.
21+
22+
FLibGoLite has been tested and works with mobile applications for reading books `PocketBook Reader`, `FBReader`, `Librera Reader`, `Cool Reader`,
23+
as well as desktop applications `Foliate` and `Thorium Reader`.
24+
You can use any other applications or devices that can read the listed book formats and work with OPDS catalogs.
25+
26+
Follow these [guide](https://vinser.github.io/flibgolite-docs/en/docs/user-guide/) to install FLibGoLite on your PC and
27+
put your books in FB2 format (zip-archives or separate files) or EPUB in the `books/stock` folder.
28+
The service processes them and enters the books details into the catalog.
29+
30+
Next, configure the reader(s) to work with the OPDS directory `http://server:8085/opds`,
31+
where `server` is the name of your PC or the IP address of the PC type `192.168.0.10`
32+
After that, you can select and download any of the books stored on the PC in the reader.
33+
Books can be selected/searched by author and genre, as well as contextual search by author and/or book title.
34+
For book readers that do not support the FB2 format, books can be converted to EPUB format when loaded.
35+
36+
Thus, you will create a library that will be used by your loved ones with smartphones, reader devices or PCs.
37+
38+
Good luck!
839

940
---
1041
___*Suggestions, bug reports and comments are welcome [here](https://github.com/vinser/flibgolite/issues)*___

0 commit comments

Comments
 (0)