From 6f0fc4566220350d076e4b7fdfb568ca81f5a6d3 Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Wed, 12 May 2021 15:14:19 +0200 Subject: move clients and themes Signed-off-by: Benjamin Brahmer --- README.md | 39 +++------------------------------------ docs/clients.md | 31 +++++++++++++++++++++++++++++++ docs/features/themes.md | 4 ++++ mkdocs.yml | 3 +++ 4 files changed, 41 insertions(+), 36 deletions(-) create mode 100644 docs/clients.md create mode 100644 docs/features/themes.md diff --git a/README.md b/README.md index bb38b8ec1..b7f5a7c21 100644 --- a/README.md +++ b/README.md @@ -6,45 +6,12 @@ The News app is an RSS/Atom feed aggregator. It offers a [RESTful API](https://github.com/nextcloud/news/tree/master/docs/externalapi/Legacy.md) for app developers. The source code is [available on GitHub](https://github.com/nextcloud/news) -## Install -See the [install document](https://github.com/nextcloud/news/blob/master/docs/install.md) - -## FAQ -* [My browser shows a mixed content warning](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#my-browser-shows-a-mixed-content-warning-connection-is-not-secure) -* [I am getting: Exception: Some\\Class does not exist erros in my nextcloud.log](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#i-am-getting-exception-someclass-does-not-exist-erros-in-my-nextcloudlog) -* [Feeds are not updated](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#feeds-not-updated) -* [Adding feeds that use self-signed certificates](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#adding-feeds-that-use-self-signed-certificates) -* [Is There An Subscription URL To Easily Subscribe To Feeds](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#is-there-an-subscription-url-to-easily-subscribe-to-feeds) -* [Database table grows too big](https://github.com/nextcloud/news/blob/master/docs/faq/README.md#database-table-grows-too-big) - -## Supported Browsers -* Newest Firefox (Desktop, Android, Firefox OS) -* Newest Chrome/Chromium (Desktop, Android) +## Documentation +The documentation can be found *here*, the source of the documentation is on [GitHub](https://github.com/nextcloud/news/blob/master/docs) ## Bugs Please read the [appropriate section in the contributing notices](https://github.com/nextcloud/news/blob/master/CONTRIBUTING.md#issues) -## Sync Clients -Nextcloud News can be synced with the following apps: - * [RSS Guard (Windows, Linux, OS/2, Mac OS)](https://github.com/martinrotter/rssguard), [open source](https://github.com/martinrotter/rssguard) - * [Nextcloud News Reader (Android)](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader), [open source](https://github.com/nextcloud/news-android-app) - * [OCReader (Android)](https://f-droid.org/repository/browse/?fdid=email.schaal.ocreader), [open source](https://github.com/schaal/ocreader) - * [Newsout (Android)](https://play.google.com/store/apps/details?id=com.inspiredandroid.newsout), [open source](https://github.com/SimonSchubert/NewsOut) - * [Readrops (Android)](https://f-droid.org/en/packages/com.readrops.app/), [open source](https://github.com/readrops/Readrops) - * [CloudNews (iOS)](https://apps.apple.com/app/cloudnews-owncloud-news-reader/id683859706), [open source](https://github.com/owncloud/news-ios-app) - * [Fiery Feeds (iOS)](https://apps.apple.com/us/app/fiery-feeds-rss-reader/id1158763303), closed source - * [News Checker (Chrome extension)](https://chrome.google.com/webstore/detail/owncloud-news-checker/hnmagnmdnfdhabdlicankfbfhcdgbfhe) - * [own News (BlackBerry)](http://appworld.blackberry.com/webstore/content/32767887/) - * [FeedSpider (Firefox OS, WebOS, LuneOS)](http://www.feedspider.net/), [open source](https://github.com/OthelloVentures/feedspider) - * [fastReader (Windows Phone)](http://www.windowsphone.com/en-us/store/app/fastreader/e55e696d-aa45-4a49-bb1c-a1fc7fdabec1), closed source - * [py3status](https://github.com/ultrabug/py3status/) for [i3 (UNIX-like)](http://i3wm.org/), [open source](https://github.com/i3/i3) - * [newsboat](http://newsboat.org/) for Unix terminal, [open source](https://github.com/newsboat/newsboat) - * [Newsie (Ubuntu Touch)](https://open-store.io/app/newsie.martinferretti), [open source](https://gitlab.com/ferrettim/newsie) - -## Custom Themes -Nextcloud News can look different with the following themes: - * [Nextcloud News Themes](https://github.com/cwmke/nextcloud-news-themes) - ## Updating Notices To receive notifications when a new News app version was released, simply add the following Atom feed in your currently installed News app: @@ -59,4 +26,4 @@ To receive notifications when a new News app version was released, simply add th * [Sean Molenaar](https://github.com/SMillerDev) ### Special thanks to the Feed-IO library -Please consider donating to the developer of the RSS parser that powers nextcloud/news: [https://github.com/sponsors/alexdebril](https://github.com/sponsors/alexdebril) +Please consider donating to the developer of the RSS parser that powers the Nextcloud News App: [https://github.com/sponsors/alexdebril](https://github.com/sponsors/alexdebril) diff --git a/docs/clients.md b/docs/clients.md new file mode 100644 index 000000000..7b9065b09 --- /dev/null +++ b/docs/clients.md @@ -0,0 +1,31 @@ +# Clients + +Clients are applications that use the REST API of News. They are not maintained by the News team. +If you are the develeoper of an app feel free to create a PR to add your app to this list. + +## Sync Clients + +A sync client can be used to read news and synchronize via the API. + +| Name | OS/Platform | License | Source | +|------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------|--------------------------------------------------------------------| +| [RSS Guard](https://github.com/martinrotter/rssguard) | Windows, Linux, OS/2, Mac OS | GPL-3.0 License | [GitHub](https://github.com/martinrotter/rssguard) | +| [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) | Android | GPL-3.0 License | [GitHub](https://github.com/nextcloud/news-android-app) | +| [OCReader](https://f-droid.org/repository/browse/?fdid=email.schaal.ocreader) | Android | GPL-3.0 License | [GitHub](https://github.com/schaal/ocreader) | +| [Newsout](https://play.google.com/store/apps/details?id=com.inspiredandroid.newsout) | Android | Apache-2.0 License | [GitHub](https://github.com/SimonSchubert/NewsOut) | +| [Readrops](https://f-droid.org/en/packages/com.readrops.app/) | Android | GPL-3.0 License | [GitHub](https://github.com/readrops/Readrops) | +| [CloudNews](https://apps.apple.com/app/cloudnews-owncloud-news-reader/id683859706) | iOS | BSD-2-Clause License | [GitHub](https://github.com/owncloud/news-ios-app) | +| [Fiery Feeds](https://apps.apple.com/us/app/fiery-feeds-rss-reader/id1158763303) | iOS | - | - | +| [News Checker](https://chrome.google.com/webstore/detail/owncloud-news-checker/hnmagnmdnfdhabdlicankfbfhcdgbfhe) | Google Chrome | - | [GitHub](https://github.com/owncloud-archive/news-chrome-notifier) | +| [own News](http://appworld.blackberry.com/webstore/content/32767887/) | Blackberry | - | - | +| [FeedSpider](http://www.feedspider.net/) | Firefox OS, webOS, LuneOS | MIT License | [GitHub](https://github.com/OthelloVentures/feedspider) | +| [fastReader](http://www.windowsphone.com/en-us/store/app/fastreader/e55e696d-aa45-4a49-bb1c-a1fc7fdabec1) | Windows Phone | - | - | +| [py3status](https://github.com/ultrabug/py3status/) | i3wm | BSD-3-Clause License | [GitHub](https://github.com/ultrabug/py3status/) | +| [newsboat](http://newsboat.org/) | Unix Terminal | | [GitHub](https://github.com/newsboat/newsboat) | +| [Newsie](https://open-store.io/app/newsie.martinferretti) | Ubuntu Touch | GPL-3.0 License | [GitLab](https://gitlab.com/ferrettim/newsie) | + +## Update Clients + +An update client uses the nextcloud API or the OCC CLI to update the feeds in News. + + diff --git a/docs/features/themes.md b/docs/features/themes.md new file mode 100644 index 000000000..663ad4ddc --- /dev/null +++ b/docs/features/themes.md @@ -0,0 +1,4 @@ +# Themes +Nextcloud News can look different with the following themes: + + * [Nextcloud News Themes](https://github.com/cwmke/nextcloud-news-themes) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index aacb57a67..8d3fa632b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,14 +5,17 @@ edit_uri: blob/master/documentation/ nav: - index.md - install.md + - clients.md - faq.md - Features: - Update Interval: features/update_interval.md - Custom CSS: features/customCSS.md - Plugins: features/plugins.md + - Themes: features/themes.md - REST API: - API v1: api/api-v1.md - API v2: api/api-v2.md + - maintenance.md theme: name: material -- cgit v1.2.3