keeweb
/
keeweb
mirror of https://github.com/keeweb/keeweb.git
1
0
Fork 0
Code Issues Releases Wiki Activity

readme formatting

This commit is contained in:
antelle 2020-05-15 20:14:55 +02:00
parent 8251423d95
commit c91e5de961
No known key found for this signature in database
GPG Key ID: 094A2F2D6136A4EE
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -5,7 +5,7 @@ The app can run either in browser, or as a desktop app.
![screenshot](img/screenshot.png) ![screenshot](img/screenshot.png)
# Quick Links ## Quick Links
Apps: [Web](https://app.keeweb.info/), [Desktop](https://github.com/keeweb/keeweb/releases/latest) Apps: [Web](https://app.keeweb.info/), [Desktop](https://github.com/keeweb/keeweb/releases/latest)
Timeline: [Release Notes](release-notes.md), [TODO](https://github.com/keeweb/keeweb/wiki/TODO) Timeline: [Release Notes](release-notes.md), [TODO](https://github.com/keeweb/keeweb/wiki/TODO)
@ -14,11 +14,11 @@ Website: [keeweb.info](https://keeweb.info)
Twitter: [kee_web](https://twitter.com/kee_web) Twitter: [kee_web](https://twitter.com/kee_web)
Donate: [OpenCollective](https://opencollective.com/keeweb#support), [GitHub](https://github.com/sponsors/antelle) Donate: [OpenCollective](https://opencollective.com/keeweb#support), [GitHub](https://github.com/sponsors/antelle)
# Status ## Status
The app is quite stable now. Basic stuff, as well as more advanced operations, should be rather reliable. The app is quite stable now. Basic stuff, as well as more advanced operations, should be rather reliable.
# Self-hosting ## Self-hosting
Everything you need to host this app on your server is any static file server. The app is a single HTML file + a service worker (optionally; for offline access). Everything you need to host this app on your server is any static file server. The app is a single HTML file + a service worker (optionally; for offline access).
You can download the latest distribution files from [gh-pages](https://github.com/keeweb/keeweb/archive/gh-pages.zip) branch. You can download the latest distribution files from [gh-pages](https://github.com/keeweb/keeweb/archive/gh-pages.zip) branch.
@ -33,7 +33,7 @@ docker run --name keeweb -d -p 443:443 -p 80:80 -v $EXT_DIR:/etc/nginx/external/
To make Dropbox work in your self-hosted app, [go to this Wiki page](https://github.com/keeweb/keeweb/wiki/Dropbox-and-GDrive). To make Dropbox work in your self-hosted app, [go to this Wiki page](https://github.com/keeweb/keeweb/wiki/Dropbox-and-GDrive).
# Building ## Building
The easiest way to clone all KeeWeb repos is: The easiest way to clone all KeeWeb repos is:
```bash ```bash
@ -54,7 +54,7 @@ For debug build:
1. run `npm run dev` 1. run `npm run dev`
2. open `http://localhost:8085` 2. open `http://localhost:8085`
# Contributing ## Contributing
Please read contribution guidelines [for pull requests](.github/PULL_REQUEST_TEMPLATE.md). Please read contribution guidelines [for pull requests](.github/PULL_REQUEST_TEMPLATE.md).
Here's a [list of issues](https://github.com/keeweb/keeweb/labels/help%20wanted) where your help would be very welcome. Here's a [list of issues](https://github.com/keeweb/keeweb/labels/help%20wanted) where your help would be very welcome.
@ -62,12 +62,12 @@ Also you can help by [translating KeeWeb](https://keeweb.oneskyapp.com) to your
Other ways of contribution can be found [on this page](CONTRIBUTING.md). Other ways of contribution can be found [on this page](CONTRIBUTING.md).
### Important notes for pull requests #### Important notes for pull requests
- please branch from `develop`, not `master` - please branch from `develop`, not `master`
- don't edit translation files except base.json, they will be replaced - don't edit translation files except base.json, they will be replaced
# Donations ## Donations
KeeWeb is not free to develop. It takes time, requires paid code signing certificates and domains. KeeWeb is not free to develop. It takes time, requires paid code signing certificates and domains.
You can help the project or say "thank you" with this button: You can help the project or say "thank you" with this button:
@ -77,7 +77,6 @@ You can also sponsor the developer directly [on GitHub](https://github.com/spons
Please note: donation does not imply any type of service contract. Please note: donation does not imply any type of service contract.
## License
# License
[MIT](https://github.com/keeweb/keeweb/blob/master/LICENSE) [MIT](https://github.com/keeweb/keeweb/blob/master/LICENSE)