diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c1ac137f..8ea7366e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ [#1093](https://github.com/nextcloud/cookbook/pull/1093) @christianlupus - Update supported PHP versions [#1095](https://github.com/nextcloud/cookbook/pull/1095) @christianlupus +- Update README with app screenshot and fixed repository links + [#1102](https://github.com/nextcloud/cookbook/pull/1102) @MarcelRobitaille ## 0.9.13 - 2022-07-02 diff --git a/README.md b/README.md index a5ec36f29..381c41ce6 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ # NextCloud Cookbook +![A screenshot of how the app looks](./docs/assets/screenshot.png) + A library for all your recipes. It uses JSON files following the schema.org recipe format. To add a recipe to the collection, you can paste in the URL of the recipe, and the provided web page will be parsed and downloaded to whichever folder you specify in the app settings. Further documentation (also internal ones) are published on the [documentation pages of the project](http://nextcloud.github.io/cookbook/). @@ -40,7 +42,7 @@ If this still doesnt work, a full, non-incremental resync might help. This can b A lot of websites are unfortunately not following the schema.org/Recipe standard, which makes their recipes impossible to read by this app. #### A website using correct schema.org markup is not being read correctly -The parser is far from perfect. If you can help out in any way, please [have a look at the parseRecipeHtml() method](https://github.com/mrzapp/nextcloud-cookbook/blob/master/lib/Service/RecipeService.php) and create a pull request with your changes. +The parser is far from perfect. If you can help out in any way, please [have a look at the parseRecipeHtml() method](https://github.com/nextcloud/nextcloud-cookbook/blob/master/lib/Service/RecipeService.php) and create a pull request with your changes. #### All of the text is in English? This app uses the [Transifex](https://www.transifex.com/nextcloud/nextcloud/cookbook/) translation system. diff --git a/docs/assets/screenshot.png b/docs/assets/screenshot.png new file mode 100644 index 000000000..a3ecc2abe Binary files /dev/null and b/docs/assets/screenshot.png differ diff --git a/package.json b/package.json index a555591e5..648c32f45 100644 --- a/package.json +++ b/package.json @@ -4,13 +4,13 @@ "description": "", "license": "AGPL-3.0-or-later", "author": "", - "homepage": "https://github.com/mrzapp/nextcloud-cookbook#readme", + "homepage": "https://github.com/nextcloud/nextcloud-cookbook#readme", "repository": { "type": "git", - "url": "git+https://github.com/mrzapp/nextcloud-cookbook.git" + "url": "git+https://github.com/nextcloud/nextcloud-cookbook.git" }, "bugs": { - "url": "https://github.com/mrzapp/nextcloud-cookbook/issues" + "url": "https://github.com/nextcloud/nextcloud-cookbook/issues" }, "main": "src/main.js", "scripts": { diff --git a/translationfiles/README.md b/translationfiles/README.md index 675f653aa..fb7155766 100755 --- a/translationfiles/README.md +++ b/translationfiles/README.md @@ -13,7 +13,7 @@ This is a quick instruction how to generate translations for the Nextcloud app ` ## TL;DR -1. Clone a user fork of the [cookbook app](https://github.com/mrzapp/nextcloud-cookbook) +1. Clone a user fork of the [cookbook app](https://github.com/nextcloud/cookbook) 2. Create new branch and checkout 3. Update the translation template by calling `update-pot.sh` in the root folder 4. Use the `translationfiles/template/cookbook.pot` template and generate/update the `translationfiles//cookbook.po` file @@ -35,7 +35,7 @@ The new translation must be put in the folder `translationfiles/` and have The `` is the [language code](http://www.lingoes.net/en/translator/langcode.htm) of the desired translation. To start a new translation you need first to create a fork of the git repository. -Click on the fork button of the repo [cookbook](https://github.com/mrzapp/nextcloud-cookbook). +Click on the fork button of the repo [cookbook](https://github.com/nextcloud/cookbook). Then in a folder on your machine check out the forked repo: ``` @@ -102,7 +102,7 @@ This will push the changed to your fork of the repo on Github. To notify the developer of the changes, you need to open a pull request. To do so, git already outputs during the `git push` command execution an URL to help creating such a pull request. Open the link in a browser and fill in the fields (sort of comments). -Make sure you are using `base: develop` of `mrzapp/nextcloud-cookbook` repository in the dropdown list. +Make sure you are using `base: develop` of `nextcloud/cookbook` repository in the dropdown list. The developer will either merge the changes into the main development branch or come back to you with further questions. ## Steps to generate the necessary files in order to test the translation