tainacan/README.md

69 lines
4.0 KiB
Markdown
Raw Normal View History

2022-02-08 12:11:42 +00:00
[![Build Status](https://travis-ci.org/tainacan/tainacan.svg?branch=develop)](https://travis-ci.org/tainacan/tainacan)
2018-06-08 15:14:29 +00:00
2017-11-26 21:17:51 +00:00
# Tainacan
2022-02-08 12:11:42 +00:00
- Tainacan's [plugin](https://wordpress.org/plugins/tainacan/) and [theme](https://wordpress.org/themes/tainacan-interface/) on WordPress.org
2019-07-18 18:54:59 +00:00
- [Access our website](http://tainacan.org)
2019-03-12 23:34:11 +00:00
- [Read our official documentation](https://wiki.tainacan.org/)
2022-02-08 12:11:42 +00:00
- [Conctact us in our forum](https://tainacan.discourse.group/)
2019-03-12 23:34:11 +00:00
- [Explore our blog](http://tainacan.org/blog/)
- [Follow us on Twitter](https://twitter.com/tainacan_l3p)
### What is Tainacan?
[![Screenshot](https://user-images.githubusercontent.com/29989176/54926885-f8cf5b80-4eef-11e9-870f-92b264f13dea.gif)][youtube_demo]
[youtube_demo]: https://www.youtube.com/watch?v=6q42dlcwW5g
2022-02-08 12:11:42 +00:00
Get to know Tainacan with our [introduction video](https://www.youtube.com/watch?v=6q42dlcwW5g).
2022-02-08 12:46:32 +00:00
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) specially designed to produce beautiful digital exhibits. [Try it out!](http://demo.tainacan.org/)
### Features
2021-04-10 06:37:45 +00:00
#### Easy install
2022-02-08 12:11:42 +00:00
2022-02-08 12:46:32 +00:00
- As a WordPress plugin, Tainacan can be easily installed on and integrated into an existing WordPress website.
2021-04-10 06:37:45 +00:00
#### Metadata and filters
2022-02-08 12:11:42 +00:00
2021-04-10 06:37:45 +00:00
- Use standard metadata 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.
2021-04-10 06:37:45 +00:00
#### Faceted search
2022-02-08 12:11:42 +00:00
2021-04-10 06:37:45 +00:00
- Browse (and let the public browse it) your collection using a faceted search interface with filters you have chosen.
2021-04-10 06:37:45 +00:00
#### Manage taxonomies
2022-02-08 12:11:42 +00:00
2022-02-08 12:46:32 +00:00
- Manage vocabularies that can be used across all your collections.
2021-04-10 06:37:45 +00:00
#### Themes
2022-02-08 12:11:42 +00:00
2021-04-10 06:37:45 +00:00
- Tainacan [has its own default theme](https://wordpress.org/themes/tainacan-interface/), which helps you present your collections in a beautiful and effective way as it is developed to incorporate all of Tainacan functionalities. However, it will also work with any WordPress theme. For developers, it will be easy to add Tainacan specific features to an existing theme.
2021-04-10 06:37:45 +00:00
#### API and interoperability
2022-02-08 12:11:42 +00:00
2022-02-08 12:46:32 +00:00
- 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 standards such as DublinCore.
### Showcases
2022-02-08 12:46:32 +00:00
Check out the digital exhibits in our [Showcase page](https://tainacan.org/en/tainacan-showcase/) to see Tainacan in action!
### Support
2022-02-08 12:46:32 +00:00
In addition to [our documentation](https://wiki.tainacan.org/) and [instructional videos](https://youtu.be/oEl9bWe_rWI), we provide technical support on our [online forum](https://tainacan.discourse.group) in English, Portuguese and Spanish. You are welcome to send all of your questions!
2022-02-08 12:11:42 +00:00
### Developers
2019-05-13 19:31:56 +00:00
2022-02-08 12:46:32 +00:00
Please refer to our [Developers Documentation](https://tainacan.github.io/tainacan-wiki/#/dev/) if you want to develop Tainacan plugins, themes or if you want to contribute to the core.
2019-05-13 19:31:56 +00:00
### Contributing
2022-02-08 12:11:42 +00:00
2022-02-08 12:46:32 +00:00
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 additional or other terms.
2022-02-08 12:46:32 +00:00
To contribute to our project, you can report bugs and other issues, or suggest new features. You are also free to submit pull requests or translate Tainacan to multiple languages. If you are interested in contributing, you can get started by reading our [contribution guidelines](docs/CONTRIBUTING.md).
### Acknowledgements
2022-02-08 12:11:42 +00:00
Tainacan is the results of continuous efforts from developers, researchers, policy makers and GLAMs in Brazil. We are eternally grateful for all of [our amazing contributors](https://github.com/tainacan/tainacan/graphs/contributors)!