Skip to content

Commit

Permalink
Update documentation to point to the doc website
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioMendolia committed Nov 30, 2024
1 parent 74d4125 commit 1e3a6bd
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 284 deletions.
27 changes: 1 addition & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,5 @@ classified libraries.


## Documentation
- [Setup the docker environment and dependencies](doc/install.md)
- [Upgrade to a newer version](doc/update.md)
- [Console Commands](doc/commands.md)
- [Adding books](doc/adding-books.md)
[Read the full documentation on the dedicated website](https://biblioverse.github.io/biblioteca-doc/)

## Features

### Dynamic shelves
You can create your own shelves and manually add books in them, or you can create smart shelves that will automatically include books based on the rules you define.

### Search
Fast and powerful search with Typesense!

### AI Tagging
Because it's 2024 some AI was bound to be in there somewhere: you can ask chatGPT to tag or write a summary of your books.

### Folder structure
You can define your own folder structure or just mount a folder with your books, scan them in the app and don't relocate them.

### Multi user
You can create multiple users and restrict them to age categories, or just let them have access to everything. (WIP)

### Themes
Light and dark themes are available, and you can easily create new themes.

### Sync with Kobo
Sync your library with your Kobo reader
6 changes: 0 additions & 6 deletions doc/adding-books.md

This file was deleted.

47 changes: 0 additions & 47 deletions doc/commands.md

This file was deleted.

69 changes: 0 additions & 69 deletions doc/docker-compose-pontsun.yml

This file was deleted.

56 changes: 0 additions & 56 deletions doc/docker-compose.yml

This file was deleted.

73 changes: 0 additions & 73 deletions doc/install.md

This file was deleted.

7 changes: 0 additions & 7 deletions doc/update.md

This file was deleted.

0 comments on commit 1e3a6bd

Please sign in to comment.