mirror of
https://github.com/hkalexling/Mango.git
synced 2025-08-03 03:15:31 -04:00
-
This commit is contained in:
parent
5eb089863c
commit
deef4d2144
16
README.md
16
README.md
@ -4,7 +4,7 @@ Mango is a self-hosted Manga Server and Reader. Its features include
|
|||||||
|
|
||||||
- Multi-user support
|
- Multi-user support
|
||||||
- Supports both `.zip` and `.cbz` formats
|
- Supports both `.zip` and `.cbz` formats
|
||||||
- Automatically store reading progress
|
- Automatically stores reading progress
|
||||||
- The web reader is responsive and works well on mobile, so there is no need for a mobile app
|
- The web reader is responsive and works well on mobile, so there is no need for a mobile app
|
||||||
- All the static files are embedded in the binary, so the deployment process is easy and painless
|
- All the static files are embedded in the binary, so the deployment process is easy and painless
|
||||||
|
|
||||||
@ -15,7 +15,7 @@ Mango is a self-hosted Manga Server and Reader. Its features include
|
|||||||
1. Make sure you have Crystal (0.32.0), Node and Yarn installed
|
1. Make sure you have Crystal (0.32.0), Node and Yarn installed
|
||||||
2. Clone the repository
|
2. Clone the repository
|
||||||
3. Run `make`
|
3. Run `make`
|
||||||
4. Move the compiled executable to your desire location and run it
|
4. Move the compiled executable to your desired location and run it
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -42,16 +42,12 @@ scan_interval_minutes: 5
|
|||||||
log_level: info
|
log_level: info
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Initial Login
|
||||||
|
|
||||||
|
On the first run, Mango would log the default username and a randomly generated password to STDOUT. You are advised to immediately change the password.
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
1. Fork it (<https://github.com/your-github-user/mango/fork>)
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
5. Create a new Pull Request
|
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
- [Alex Ling](https://github.com/your-github-user) - creator and maintainer
|
- [Alex Ling](https://github.com/your-github-user) - creator and maintainer
|
||||||
|
Loading…
x
Reference in New Issue
Block a user