tmdinosaurcenter
/
tainacan
mirror of https://github.com/tainacan/tainacan
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tainacan/README.md

46 lines
3.6 KiB
Markdown
Raw Normal View History

add Travis status to Readme
2018-07-05 16:38:28 +00:00
[![Build Status](https://travis-ci.org/tainacan/tainacan.svg?branch=develop)](https://travis-ci.org/tainacan/tainacan) [![Waffle.io - Columns and their card count](https://badge.waffle.io/tainacan/tainacan.svg?columns=In%20Progress)](https://waffle.io/tainacan/tainacan)
add waffle.io badge to readme
2018-06-08 15:14:29 +00:00
Documentation!
2017-11-26 21:17:51 +00:00
# Tainacan
Extends social media links
2019-03-12 23:34:11 +00:00
- [Tainacan on WordPress.org](https://wordpress.org/plugins/tainacan/)
- [Access our homepage](http://tainacan.org)
- [Read our official documentation](https://wiki.tainacan.org/)
- [Explore our blog](http://tainacan.org/blog/)
- [Join our mailing list](https://lists.riseup.net/www/info/tainacan)
- [Follow us on Twitter](https://twitter.com/tainacan_l3p)
primeira versã odo repo com testes e build
2017-10-20 14:30:04 +00:00
Clears up README.md and adds better description - Adds explicit mention to the theme's repository - Adds a description about Tainacan's API
2019-03-04 18:58:21 +00:00
### What is Tainacan?
primeira versã odo repo com testes e build
2017-10-20 14:30:04 +00:00
Adds a Tainacan GIF with our introduction video It needs to be replaced with a higher quality GIF in the future. This one is for proof-of-concept purposes.
2019-03-19 21:19:05 +00:00
[![Screenshot](https://user-images.githubusercontent.com/29989176/54641974-407a6100-4a72-11e9-9eb1-05fbd981d2a9.gif)][youtube_demo]
[youtube_demo]: https://www.youtube.com/watch?v=6q42dlcwW5g
Get to know Tainacan with our [introduction video](https://www.youtube.com/watch?v=6q42dlcwW5g).
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
2019-03-11 15:34:29 +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) especially designed to produce beautiful digital exhibits.
primeira versã odo repo com testes e build
2017-10-20 14:30:04 +00:00
Clears up README.md and adds better description - Adds explicit mention to the theme's repository - Adds a description about Tainacan's API
2019-03-04 18:58:21 +00:00
### Features
primeira versã odo repo com testes e build
2017-10-20 14:30:04 +00:00
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
2019-03-11 15:34:29 +00:00
**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
Adds acknowledgements, mentions instructional videos
2019-03-19 20:58:09 +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 [mailing list](https://lists.riseup.net/www/info/tainacan) in English, Portuguese and Spanish. You are welcome to send all of your questions!
Adds Important links and Contributing sections to README
2019-02-22 18:00:49 +00:00
### Contributing
Adds a Tainacan GIF with our introduction video It needs to be replaced with a higher quality GIF in the future. This one is for proof-of-concept purposes.
2019-03-19 21:19:05 +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.
Adds Important links and Contributing sections to README
2019-02-22 18:00:49 +00:00
Clears up README.md and adds better description - Adds explicit mention to the theme's repository - Adds a description about Tainacan's API
2019-03-04 18:58:21 +00:00
To contribute with 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).
Adds acknowledgements, mentions instructional videos
2019-03-19 20:58:09 +00:00
### Acknowledgements
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)!