Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/photos.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Mors <corentin.mors@dashlane.com>2020-01-17 14:24:08 +0300
committerCorentin Mors <corentin.mors@dashlane.com>2020-01-17 14:49:16 +0300
commit4d47589ce47e80b1f7100823d90b5c7e734bb6ff (patch)
tree3a353ff40cf699c9354a75b95406380608398fab /README.md
parentf52bb5aaafa3fdc44fe34e8da10c2f628add61ce (diff)
Lint readme
Signed-off-by: Corentin Mors <corentin.mors@dashlane.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 27 insertions, 22 deletions
diff --git a/README.md b/README.md
index 2ed01c0c..ac89d908 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,39 @@
# Nextcloud Photos
+
**πŸ“Έ Your memories under your control**
-![](screenshots/screenshot1.png)
+![Work in progress screenshot of Nextcloud Photos App](screenshots/screenshot1.png)
## Why is this so awesome?
-- **πŸ“Έ Beautiful Photo und Video Timeline**
-- **⭐ Favorites and Tagging:** Favorite and tag your photos!
-- **Slideshow and easy sharing** Show slideshows and share your photos or albums easy
-- **Albums:** Create albums from your contents
-
- Future plans:
-- ...
-
-## πŸš€ Installation
+
+* **πŸ“Έ Beautiful Photo und Video Timeline**
+* **⭐ Favorites and Tagging:** Favorite and tag your photos!
+* **Slideshow and easy sharing:** Show slideshows and share your photos or albums easy
+* **Albums:** Create albums from your contents
+
+## πŸš€ Installation
+
In your Nextcloud, simply enable the Photos app through the Apps management.
-Consider installing the [preview generator](https://github.com/rullzer/previewgenerator) for pregenerating thumbnails.
+Consider installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails.
Please have a look at [CHANGELOG.md](https://github.com/nextcloud/photos/blob/master/CHANGELOG.md) for details about changes.
-
+
## Mobile Photos
+
Use the Android/iOS App to view your photos. It's possible to auto-upload them.
-##Maintainers:
-- [John Molakvoæ](https://github.com/skjnldsv)
-If you'd like to join, just go through the [issue list](https://github.com/nextcloud/photos/issues) and fix some. :)
-
+## Maintainers
+
+* [John Molakvoæ](https://github.com/skjnldsv)
+
+If you'd like to join, just go through the [issues list](https://github.com/nextcloud/photos/issues) and fix some!
+
## πŸ— Development setup
-1. ☁ Clone this into your `apps` folder of your Nextcloud
-2. πŸ‘©β€πŸ’» In a terminal, run the command `make dev-setup` to install the dependencies
-3. πŸ— Then to build the Javascript whenever you make changes, run `make build-js`. Watch changes with: `make watch-js`
-4. βœ… Enable the app through the app management of your Nextcloud
-5. πŸŽ‰ Partytime!
-6. πŸ’» Fix easily linting issues with `npm run lint:fix`
+
+1. ☁ Clone this into your `apps` folder of your Nextcloud.
+1. πŸ‘©β€πŸ’» In a terminal, run the command `make dev-setup` to install the dependencies.
+1. πŸ— Then to build the Javascript whenever you make changes, run `make build-js`. Watch changes with: `make watch-js`.
+1. βœ… Enable the app through the app management of your Nextcloud.
+1. πŸŽ‰ Partytime!
+1. πŸ’» Fix easily linting issues with `npm run lint:fix`.
+