Updates to the README.md

- Adds the current description of the plugin on WordPress to the repository on GitHub, and highlights of the most interesting features
- Mentions that support is provided on the mailing list
This commit is contained in:
Anna e só 2019-03-11 12:34:29 -03:00 committed by GitHub
parent f9f4cdb7f0
commit d08cee8150
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions

View File

@ -5,11 +5,25 @@
### What is Tainacan?
Tainacan is a software solution for building, managing and publishing digital repositories of any kind. It is composed of a WordPress plugin, which is being developed on this repository, and a [companion WordPress theme](https://github.com/tainacan/tainacan-theme) especially designed to produce beautiful digital exhibits.
Tainacan is a software solution for building, managing and publishing digital repositories of any kind on WordPress. Manage and publish you digital collections as easily as publishing a post to your blog, while having all the tools of a professional repository platform. It is composed of a WordPress plugin, which is being developed on this repository, and an optional [companion WordPress theme](https://github.com/tainacan/tainacan-theme) especially designed to produce beautiful digital exhibits.
### Features
**API and interoperability**. Taincan implements an API RESTful that allows other applications to interact with your repository. Display your collection in different formats such as JSON, JSON-LD and OAI-PMH. If your collection uses a custom standard, you can map it to well-known stardards such as DublinCore.
**Easy installation**. As a WordPress plugin, Tainacan can be easily installed on and integrated to an existing WordPress website.
**Metadata and filters**. Use a metadata standard or choose whatever set of metadata you want to describe the items in your collections. You can choose which metadata will be used as a filter when browsing the collection.
**Faceted search**. Browse your collection (and let the public browse it) using a faceted search interface with the filters you have chosen.
**Manage taxonomies**. Manage vocabularies that can be used accross all your collections.
**Themes**. Tainacan has its own default theme, that helps you present your collections in a beautiful and effective way, but will also work with any WordPress theme. For developers, it will be easy to add Tainacan specific features to an existing theme.
**API and interoperability**. Tainacan implements a RESTful API (read and write) to allow other applications to interact with your repository. Expose you collection in different formats, such as JSON, JSON-LD and OAI-PMH. If your collection uses a custom standard, you can map it to well-known stardards such as DublinCore.
### Support
We provide technical support on our [mailing list](https://lists.riseup.net/www/info/tainacan) in English, Portuguese and Spanish.
### Contributing
Tainacan is a free, open source software licensed under **GPLv3**. Contributions to the codebase will abide to the same license; other contributions may be under aditional or other terms.