Browse Source

Various corrections

microsub
J. King 5 years ago
parent
commit
f0c99edd22
  1. 10
      docs/en/010_About.md
  2. 2
      docs/en/030_Supported_Protocols/010_NextCloud_News.md
  3. 2
      docs/en/030_Supported_Protocols/030_Fever.md
  4. 2
      docs/en/040_Compatible_Clients.md
  5. 2
      docs/en/050_Configuring_The_Arsse.md

10
docs/en/010_About.md

@ -1,6 +1,10 @@
The Arsse is a news aggregator server which implements multiple synchronization protocols, including [version 1.2](https://github.com/nextcloud/news/blob/master/docs/externalapi/Legacy.md) of [NextCloud News](https://github.com/nextcloud/news)' protocol and the [Tiny Tiny RSS](https://git.tt-rss.org/git/tt-rss/wiki/ApiReference) protocol (details below). Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on existing protocols to maximize compatibility with existing clients.
The Arsse is a news aggregator server which implements multiple synchronization protocols. Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on existing protocols to maximize compatibility with existing clients. Supported protocols are:
At present the software should be considered in an "alpha" state: though its core subsystems are covered by unit tests and should be free of major bugs, not everything has been rigorously tested. Additionally, many features one would expect from other similar software have yet to be implemented. Areas of future work include:
- [NextCloud News](https://github.com/nextcloud/news/blob/master/docs/externalapi/Legacy.md)
- [Tiny Tiny RSS](https://git.tt-rss.org/git/tt-rss/wiki/ApiReference)
- [Fever](https://web.archive.org/web/20161217042229/https://feedafever.com/api)
- Providing more sync protocols (Google Reader, Fever, others)
At present the software should be considered in an "alpha" state: many features one would expect from other similar software have yet to be implemented. Areas of future work include:
- Providing more sync protocols (Google Reader, others)
- Better packaging and configuration samples

2
docs/en/030_Supported_Protocols/010_NextCloud_News.md

@ -36,4 +36,4 @@ It allows organizing newsfeeds into single-level folders, and supports a wide ra
# Interaction with nested folders
Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into folders nested to arbitrary depth. When nesfeeds are placed into nested folders, they simply appear in the top-level folder when accessed via the NextCloud News protocol.
Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into folders nested to arbitrary depth. When newsfeeds are placed into nested folders, they simply appear in the top-level folder when accessed via the NextCloud News protocol.

2
docs/en/030_Supported_Protocols/030_Fever.md

@ -4,7 +4,7 @@
The Fever protocol is a basic protocol which has historically been popular with iOS and macOS clients.
It allows marking articles as read or starred, but does not allow adding or modifying newsfeeds. Instead of being classified into folders, newfeeds may belong to multiple groups, which do not nest.
It allows marking articles as read or starred, but does not allow adding or modifying newsfeeds. Moreover, instead of being classified into folders, newfeeds may belong to multiple groups, which do not nest.
<dl>
<dt>Supported since</dt>

2
docs/en/040_Compatible_Clients.md

@ -1,4 +1,4 @@
The Arsse does not at this time have any first party clients. However, because The Arsse supports other protocols, most clients built for NextCloud News and Tiny Tiny RSS are compatible with The Arsse. Below are a few that we personally know of and have tested with The Arsse.
The Arsse does not at this time have any first party clients. However, because The Arsse [supports existing protocols](/en/Supported_Protocols), most clients built for these protocols are compatible with The Arsse. Below are those that we personally know of and have tested with The Arsse.
<style>
.clients thead tr:first-child th {

2
docs/en/050_Configuring_The_Arsse.md

@ -64,7 +64,7 @@ The number of seconds to wait before returning a timeout error when executing a
| PostgreSQL | 1 millisecond | forever |
| MySQL | 1 second | forever |
With MySQL this timeout only to read operations, whereas PostgreSQL will time out write operations as well.
With MySQL this timeout only applies to read operations, whereas PostgreSQL will time out write operations as well.
### dbTimeoutLock

Loading…
Cancel
Save