diff --git a/README.md b/README.md index 74ca56a9..c782c545 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -> ⚠️ **IMPORTANT** ⚠️ -> Users of this app are practically testers. We're limited on resources, and still working out how to make this app function the best it can. There will be regressions and bugs. And we of course appreciate constructive feedback whenever users run into them. +
+# 🧑‍🍳 Nextcloud Cookbook +
+ Join us on Matrix @@ -12,63 +14,56 @@ ![GitHub Repo stars](https://img.shields.io/github/stars/nextcloud/cookbook?logo=github) ![GitHub all releases](https://img.shields.io/github/downloads/nextcloud/cookbook/total?logo=github) -# NextCloud Cookbook -

-A screenshot of how the app looks +

+A screenshot of how the app looks

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/). -## Clients -The app works generally in any modern browser. Additionally, there are some more specialized clients listed here. -### Mobile -The currently available clients are: +## 📱 Clients -[Nextcloud Cookbook](https://micmun.de/nextcloud-cookbook-english/) (by MicMun) -[Get it on F-Droid](https://f-droid.org/en/packages/de.micmun.android.nextcloudcookbook/) [Get it on Google Play](https://play.google.com/store/apps/details?id=de.micmun.android.nextcloudcookbook&hl=en_US&gl=US&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1/) +The app works generally in any modern browser. Additionally, there are some more specialized clients available, including mobile apps for Android and iOS. You can find an overview [here](docs/user/clients/Index.md). -[Nextcloud Cookbook](https://github.com/Teifun2/nextcloud-cookbook-flutter) (by Teifun2) -[Get it on F-Droid](https://f-droid.org/en/packages/com.nextcloud_cookbook_flutter/) [Get it on Google Play](https://play.google.com/store/apps/details?id=com.nextcloud_cookbook_flutter&hl=en_US&gl=US) [Download on the App Store](https://apps.apple.com/us/app/nextcloud-cookbook/id1619926634?itsct=apps_box_badge&itscg=30200) -Nook -[Get it on Google Play](https://play.google.com/store/apps/details?id=org.capacitor.cookbook.app) +## 💼 Is it Production Ready? -[Nextcloud Cookbook](https://lneugebauer.github.io/nextcloud-cookbook/) (by lneugebauer) -[Get it on F-Droid](https://f-droid.org/packages/de.lukasneugebauer.nextcloudcookbook/) [Get it on Play Store](https://play.google.com/store/apps/details?id=de.lukasneugebauer.nextcloudcookbook) +> ⚠️ **IMPORTANT** ⚠️ +> Users of this app are practically testers. We're limited on resources and still working out how to make this app function the best it can. There will be regressions and bugs. And we of course appreciate constructive feedback whenever users run into them. -[Cookbook Client](https://github.com/VincentMeilinger/Nextcloud-Cookbook-iOS/) -[Download on the App Store](https://apps.apple.com/de/app/cookbook-client/id6467141985) +## 💰 Sponsoring -### Browser plugins/scripts +We thank the sponsors of this project for their support as open-source software. -- [add-nextcloud-cookbook](https://github.com/qutebrowser/qutebrowser/blob/master/misc/userscripts/add-nextcloud-cookbook) - qutebrowser userscript that allows users to easily add new recipes +[Blackfire Logo](https://www.blackfire.io) -## Sponsoring +[Browserstack Logo](https://www.browserstack.com/) -We thank the sponsrs of this project for their support as open source software. +## 📖 F.A.Q. -### Blackfire -[Blackfire Logo](https://www.blackfire.io) +
+ I can't see my recipes -### Browser Stack -[Browserstack Logo](https://www.browserstack.com/) +Recipes are only shown in the UI if they are present in the database. It is likely you have recipes that haven't been indexed/added to the database yet. Try clicking the Settings > Rescan library button to compare the database with what is in your recipes folder and apply any differences to the database. -## F.A.Q. +If this still doesn't work, a full, non-incremental resync might help. This can be done by setting your recipes folder to a different (ideally empty) folder to clear the database. Setting the recipes folder back to what it was before should cause all your recipes to sync again, effectively refreshing the database. +
-#### I can't see my recipes -Recipes are only shown in the UI if they are present in the database. It is likely you have recipes that haven't been indexed/added to the database yet. Try clicking the Settings > Rescan library button to compare the database with what is in your recipes folder and apply any differences to the database. +
+ "Could not load recipe" when trying to download recipes? -If this still doesnt work, a full, non-incremental resync might help. This can be done by setting your recipes folder to a different (ideally empty) folder to clear the database. Setting the recipes folder back to what it was before should cause all your recipes to sync again, effectively refreshing the database - -#### "Could not load recipe" when trying to download recipes? 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 +
+ 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/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://app.transifex.com/nextcloud/nextcloud/cookbook/) translation system. +
+ All of the text is in English? + This app uses the [Transifex](https://app.transifex.com/nextcloud/nextcloud/cookbook/) translation system. You might want to register there to help translating the app to new languages or report errors in existing translations. +
diff --git a/docs/user/clients/Index.md b/docs/user/clients/Index.md new file mode 100644 index 00000000..f4e43fc2 --- /dev/null +++ b/docs/user/clients/Index.md @@ -0,0 +1,51 @@ +## Clients + +The app works generally in any modern browser. Additionally, there are some more specialized clients available, including mobile apps for Android and iOS.. + +## 📱 Mobile Applications +The currently available clients are in no particular order: + +| Name | Author | Sources | +|------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Nextcloud Cookbook][micmun-nextcloud-cookbook] | [MicMun][micmun] | [Get it on F-Droid][micmun-nextcloud-cookbook-fdroid] [Get it on Google Play][micmun-nextcloud-cookbook-play-store] | +| [Nextcloud Cookbook][teifun2-nextcloud-cookbook] | [Teifun2][teifun2] | [Get it on F-Droid][teifun2-nextcloud-cookbook-fdroid] [Get it on Google Play][teifun2-nextcloud-cookbook-play-store] [Download on the App Store][teifun2-nextcloud-cookbook-ios-app-store] | +| Nook | | [Get it on Google Play][nook-play-store] | +| [Nextcloud Cookbook][lneugebauer-nextcloud-cookbook] | [lneugebauer][] | [Get it on F-Droid][lneugebauer-nextcloud-cookbook-fdroid] [Get it on Google Play][lneugebauer-nextcloud-cookbook-play-store] | +| [Cookbook Client][teifun2-nextcloud-cookbook] | [VincentMeilinger][] | [Download on the App Store][teifun2-nextcloud-cookbook-ios-app-store] | + + + + + +[micmun]: +[micmun-nextcloud-cookbook]: (Nextcloud Cookbook) +[micmun-nextcloud-cookbook-fdroid]: (Nextcloud Cookbook F-Droid) +[micmun-nextcloud-cookbook-play-store]: (Nextcloud Cookbook Google Play Store) + + +[teifun2]: +[teifun2-nextcloud-cookbook]: (Nextcloud Cookbook) +[teifun2-nextcloud-cookbook-fdroid]: (Nextcloud Cookbook F-Droid) +[teifun2-nextcloud-cookbook-play-store]: (Nextcloud Cookbook Google Play Store) +[teifun2-nextcloud-cookbook-ios-app-store]: (Nextcloud Cookbook iOS App Store) + + +[nook-play-store]: (Nook Google Play Store) + + +[lneugebauer]: +[lneugebauer-nextcloud-cookbook]: (Nextcloud Cookbook) +[lneugebauer-nextcloud-cookbook-fdroid]: (Nextcloud Cookbook F-Droid) +[lneugebauer-nextcloud-cookbook-play-store]: (Nextcloud Cookbook Google Play Store) + + +[VincentMeilinger]: +[teifun2-nextcloud-cookbook-ios-app-store]: (Nextcloud Cookbook iOS App Store) + + + + + +## 🧑‍💻 Browser plugins/scripts + +- [add-nextcloud-cookbook](https://github.com/qutebrowser/qutebrowser/blob/master/misc/userscripts/add-nextcloud-cookbook) - qutebrowser userscript that allows users to easily add new recipes diff --git a/docs/user/clients/img/f-droid.png b/docs/user/clients/img/f-droid.png new file mode 100644 index 00000000..a7f709ff Binary files /dev/null and b/docs/user/clients/img/f-droid.png differ diff --git a/docs/user/clients/img/g-play.png b/docs/user/clients/img/g-play.png new file mode 100644 index 00000000..131f3aca Binary files /dev/null and b/docs/user/clients/img/g-play.png differ diff --git a/docs/user/clients/img/ios-store.svg b/docs/user/clients/img/ios-store.svg new file mode 100644 index 00000000..2c2e0961 --- /dev/null +++ b/docs/user/clients/img/ios-store.svg @@ -0,0 +1,46 @@ + + Download_on_the_App_Store_Badge_US-UK_RGB_blk_4SVG_092917 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file