Improving the README.

It's still too simplistic, but the following items have to be here:
 - specifying the vCard version supported ;
 - specifying the requirements ;
 - links to the specifications and useful stuff.
This commit is contained in:
Rodolphe Breard 2015-09-05 22:17:49 +02:00
parent f77a385101
commit 973cfabe69

View file

@ -1,3 +1,17 @@
# VCF Compressor # VCF Compressor
A simple bash script that compress images inside a vCard. A simple bash script that compress images inside a vCard 3.0.
## Requirements
* bash
* imagemagick
## Further reading
* [vCard on Wikipedia](https://en.wikipedia.org/wiki/VCard)
* vCard 3.0: [RFC 2425](https://tools.ietf.org/html/rfc2425) and [RFC 2426](https://tools.ietf.org/html/rfc2426)
* vCard 4.0: [RFC 6350](https://tools.ietf.org/html/rfc6350)
* CardDAV: [RFC 6352](https://tools.ietf.org/html/rfc6352)