Skip to content

Commit bbb200c

Browse files
authored
Update README with improved content and formatting (#2081)
* Update README after subproject split * Move logo path from app to core module * Remove Tasks from synctools description * Clean up third-party libraries section * Update README with improved formatting and content * Add emoji and key features section * Improve support and contribution sections * Clean up whitespace and formatting * Update donation and purchase links
1 parent ddc5014 commit bbb200c

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
1-
21
[![Follow @davx5app@fosstodon.org](https://img.shields.io/mastodon/follow/109598783742737223?domain=https%3A%2F%2Ffosstodon.org&style=flat-square)](https://fosstodon.org/@davx5app)
32
[![Website](https://img.shields.io/website?style=flat-square&up_color=%237cb342&url=https%3A%2F%2Fwww.davx5.com)](https://www.davx5.com/)
43
[![License](https://img.shields.io/github/license/bitfireAT/davx5-ose?style=flat-square)](https://github.com/bitfireAT/davx5-ose/blob/main/LICENSE)
54
[![F-Droid](https://img.shields.io/f-droid/v/at.bitfire.davdroid?style=flat-square)](https://f-droid.org/packages/at.bitfire.davdroid/)
65
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bitfireAT/davx5-ose/total?label=GitHub%20downloads)
76

8-
![DAVx⁵ logo](app/src/main/res/mipmap-xxxhdpi/ic_launcher.png)
9-
7+
![DAVx⁵ logo](core/src/main/res/mipmap-xxxhdpi/ic_launcher.png)
108

11-
DAVx⁵
9+
📱 DAVx⁵
1210
========
1311

1412
> [!IMPORTANT]
1513
> Please see the [DAVx⁵ Web site](https://www.davx5.com) for
1614
> comprehensive information about DAVx⁵, including a list of services it has been tested with,
1715
> a manual and FAQ.
1816
17+
**Key features**
18+
19+
* CalDAV/CardDAV synchronization for Android
20+
* Live [WebDAV file access over Storage Access Framework](https://manual.davx5.com/webdav_mounts.html)
21+
* Contacts, calendars, and tasks sync
22+
* Open-source and privacy-focused
23+
* Supports self-hosted servers
24+
* Easy setup with automatic configuration
25+
1926
DAVx⁵ is licensed under the [GPLv3 License](LICENSE).
2027

21-
News and updates:
28+
📰 **News and updates**:
2229

2330
* [@davx5app@fosstodon.org](https://fosstodon.org/@davx5app) on Mastodon
2431

25-
**Help, feature requests, bug reports: [DAVx⁵ discussions](https://github.com/bitfireAT/davx5-ose/discussions)**
32+
🗨️ **Help, feature requests, bug reports: [DAVx⁵ discussions](https://github.com/bitfireAT/davx5-ose/discussions)**
33+
34+
## Support & Contribution
35+
36+
* [Support guidelines](SUPPORT.md) – How to get help and report issues
37+
* [Contribution guidelines](CONTRIBUTING.md) – How to contribute to DAVx⁵
38+
* [Security policy](SECURITY.md) – Responsible vulnerability disclosure
2639

2740
Parts of DAVx⁵ have been outsourced into these libraries:
2841

2942
* [cert4android](https://github.com/bitfireAT/cert4android) – custom certificate management
3043
* [dav4jvm](https://github.com/bitfireAT/dav4jvm) – WebDAV/CalDav/CardDAV framework
31-
* [synctools](https://github.com/bitfireAT/synctools) – iCalendar/vCard/Tasks processing and content provider access
44+
* [synctools](https://github.com/bitfireAT/synctools) – iCalendar/vCard processing and content provider access
3245

33-
**If you want to support DAVx⁵, please consider [donating to DAVx⁵](https://www.davx5.com/donate)
46+
💰 **If you want to support DAVx⁵, please consider [donating to DAVx⁵](https://www.davx5.com/donate)
3447
or [purchasing it](https://www.davx5.com/download).**
35-
36-
37-
USED THIRD-PARTY LIBRARIES
38-
==========================
39-
40-
The most important libraries which are used by DAVx⁵ (alphabetically):
41-
42-
* [dnsjava](https://github.com/dnsjava/dnsjava)[BSD License](https://github.com/dnsjava/dnsjava/blob/master/LICENSE)
43-
* [ez-vcard](https://github.com/mangstadt/ez-vcard)[New BSD License](https://github.com/mangstadt/ez-vcard/blob/master/LICENSE)
44-
* [iCal4j](https://github.com/ical4j/ical4j)[New BSD License](https://github.com/ical4j/ical4j/blob/develop/LICENSE.txt)
45-
* [okhttp](https://square.github.io/okhttp)[Apache License, Version 2.0](https://square.github.io/okhttp/#license)
46-
47-
See _About / Libraries_ in the app for all used libraries and their licenses.

0 commit comments

Comments
 (0)