Skip to content
This repository was archived by the owner on May 26, 2026. It is now read-only.

Commit cb4f75f

Browse files
committed
Replace README with repository integration notice
1 parent f9b8b55 commit cb4f75f

1 file changed

Lines changed: 3 additions & 65 deletions

File tree

README.md

Lines changed: 3 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,7 @@
11

2-
[![Development tests](https://github.com/bitfireAT/synctools/actions/workflows/tests.yml/badge.svg)](https://github.com/bitfireAT/synctools/actions/workflows/tests.yml)
3-
[![Documentation](https://img.shields.io/badge/documentation-kdoc-brightgreen)](https://bitfireat.github.io/synctools/)
4-
5-
6-
# bitfireAT/synctools
7-
8-
This library for Android provides:
9-
10-
- low-level access to contacts, calendar and task content providers and
11-
- mappings between iCalendar/vCard and the content providers.
12-
13-
It is mainly used by [DAVx⁵](https://www.davx5.com).
14-
15-
Generated KDoc: https://bitfireat.github.io/synctools/
16-
17-
For questions, suggestions etc. use [Github discussions](https://github.com/bitfireAT/synctools/discussions).
18-
We're happy about contributions! In case of bigger changes, please let us know in the discussions before.
19-
Then make the changes in your own repository and send a pull request.
20-
21-
22-
# Packages
23-
24-
- `at.bitfire.synctools`: new package where everything shall be refactored into
25-
- `.icalendar`: high-level operations on iCalendar objects
26-
- `.mapping`: mappers between low-level (database rows) and high-level (iCalendar/vCard) objects
27-
- `.storage`: low-level operations on content-provider storage (`ContentValues` / `Entity` to store data)
28-
- `at.bitfire.ical4android`: legacy [ical4android](https://github.com/bitfireAT/ical4android)
29-
- `at.bitfire.vcard4android`: legacy [vcard4android](https://github.com/bitfireAT/vcard4android)
30-
31-
32-
33-
# How to use
34-
35-
Add the [jitpack.io](https://jitpack.io) repository to your project's level `build.gradle`:
36-
```groovy
37-
allprojects {
38-
repositories {
39-
// ... more repos
40-
maven { url "https://jitpack.io" }
41-
}
42-
}
43-
```
44-
45-
or if you are using `settings.gradle`:
46-
47-
```groovy
48-
dependencyResolutionManagement {
49-
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
50-
repositories {
51-
// ... more repos
52-
maven { url "https://jitpack.io" }
53-
}
54-
}
55-
```
56-
57-
Then add the dependency to your module's `build.gradle` file:
58-
```groovy
59-
dependencies {
60-
implementation 'com.github.bitfireat:synctools:<commit-id>'
61-
}
62-
```
63-
64-
To view the available gradle tasks for the library: `./gradlew synctools:tasks`
65-
(the `synctools` module is defined in `settings.gradle`).
66-
2+
> [!IMPORTANT]
3+
> This repository [has been integrated](https://github.com/bitfireAT/synctools/issues/385)
4+
> into [davx5-ose](https://github.com/bitfireAT/davx5-ose) as a Gradle submodule.
675
686
## License
697

0 commit comments

Comments
 (0)