README.md 2.91 KB
Newer Older
Calvin Timmer's avatar
Calvin Timmer committed
1 2 3 4 5 6
***CardBook*** - *a new Thunderbird address book based on the CardDAV and vCard standards*

--------

### Features

7
* **Autocompletion** in mail address fields and Lightning calendar fields!
Calvin Timmer's avatar
Calvin Timmer committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
* Easy **CardDAV synchronisation**!
* Access to **all vCard data**!
* **Customizable** data fields!
* *And many more ...*


### Installation

You can get CardBook from the [official Thunderbird Add-On page](https://addons.mozilla.org/thunderbird/addon/cardbook/)!


### Issues

If you encounter any problems with CardBook please have a look at our [GitHub issue tracker](https://github.com/CardBook/CardBook/issues) and [our forum](https://cardbook.6660.eu/).
If your problem is not listed there, you can do us a great favor by creating a new issue. But even if there is already an issue discussing the topic, you could help us by providing additional information in a comment.

When you are creating an issue, please give the following information:
* a detailed describtion of the problem
* the situation the problem occurs in and how other people will be able to recreate it
* your Thunderbird version (you can find this in the main menu at `Help -> About Thunderbird`)
* if possible: the **relevant** output of the error console (found at `Tools -> Developer Tools -> Error Console` / `Ctrl-Shift-J`)


### Roadmap

Planned features:
* Better integration with the standard Thunderbird address book

Community efforts:
* A project wiki (in GitHub)


### Contribution

You are welcomed to contribute to this project by:
ovari's avatar
ovari committed
43
* adding translations at [locale](https://github.com/CardBook/CardBook/tree/master/chrome/locale),
Calvin Timmer's avatar
Calvin Timmer committed
44 45 46 47 48 49 50 51 52 53 54
* creating issues about problems,
* creating issues about possible improvements,
* helping people who have problems or questions,
* improving the documentation,
* working on the code,
* or simply spreading the word about this great add-on.


### Special thanks to

Main contributors:
ovari's avatar
ovari committed
55
* Philippe Vigneau (author and maintainer)
ovari's avatar
ovari committed
56
* [Alexander Bergmann](https://addons.mozilla.org/thunderbird/user/tempuser/)
CardBook's avatar
CardBook committed
57
* [Günter Gersdorf](https://addons.mozilla.org/thunderbird/user/guenter-gersdorf/)
ovari's avatar
ovari committed
58
* [R. Kent James](https://github.com/rkent)
ovari's avatar
ovari committed
59 60 61 62 63
* Timothe Litt
* Christoph Mair
* Boris Prüssmann
* Michael Roland
* Lukáš Tyrychtr
Calvin Timmer's avatar
Calvin Timmer committed
64 65

Translations by:
ovari's avatar
ovari committed
66
* Lukáš Tyrychtr (cs)
ovari's avatar
ovari committed
67
* Johnny Nielsen (da)
ovari's avatar
ovari committed
68 69 70 71 72 73 74
* Alexander Bergmann (de)
* Markus Mauerer (de)
* Oliver Schuppe (de)
* SusiTux (de)
* Timothe Litt (en-US)
* Óvári (en-US)
* Philippe Vigneau (fr)
ovari's avatar
ovari committed
75
* Meri (hr)
ovari's avatar
ovari committed
76
* Óvári (hu)
ovari's avatar
ovari committed
77
* Stefano Bloisi (it)
ovari's avatar
ovari committed
78
* Agnese Morettini (it)
CardBook's avatar
CardBook committed
79
* Gintautas (lt)
ovari's avatar
ovari committed
80 81 82
* Han Knols (nl)
* Adam Gorzkiewicz (pl)
* Dominik Wnęk (pl)
ovari's avatar
ovari committed
83
* [André Bação](https://github.com/abacao) (pt-PT)
ovari's avatar
ovari committed
84
* Lucian Burca (ro)
ovari's avatar
ovari committed
85 86
* Alexander Yavorsky (ru)
* Peter Klofutar (sl)
CardBook's avatar
CardBook committed
87 88
* Anders (sv-SE)
* Kire Dyfvelsten (sv-SE)
Calvin Timmer's avatar
Calvin Timmer committed
89

90 91
Trailblazer:
* [Thomas McWork](https://github.com/thomas-mc-work): midwife for the public git repository
Calvin Timmer's avatar
Calvin Timmer committed
92 93 94

### License

ovari's avatar
ovari committed
95
[Mozilla Public License version 2.0](https://github.com/CardBook/CardBook/blob/master/LICENSE.txt)