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

Clears up README.md and adds better description 

- Adds explicit mention to the theme's repository
- Adds a description about Tainacan's API
This commit is contained in:
Anna e só 2019-03-04 15:58:21 -03:00 committed by GitHub
parent 3852de9d64
commit 43ad64369d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,30 +1,19 @@
[![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)
# Tainacan
[Homepage](http://tainacan.org) / [Blog](http://tainacan.org/blog/) / [Documentation](https://wiki.tainacan.org/) / [Mailing list](https://lists.riseup.net/www/info/tainacan) / [Twitter](https://twitter.com/tainacan_l3p)
** This is the development repository of a new version of Tainacan. If you are looking for the current stable version, please visit http://github.com/medialab-ufg/tainacan. **
### What is Tainacan?
Tainacan is a WordPress plugin to build digital repositories. Manage and publish digital collections of any kind.
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.
In this repository, we are building a new version of tainacan. The package will be composed of a WordPress plugin (this repository) and a WordPress Theme. More details of the architecture will be added here soon.
### Features
We plan to mantain this repository well documented to encourage early testers and contributors, so feel free to try it.
First, get to know the [key concepts](docs/key-concepts.md) of tainacan and what it does. After that you may want to learn [how to set up your local enviroment](docs/setup-local.md).
We are still in early stages of development, and any help, feedback or contribution is welcome. Please drop us a line opening an issue or via one of our communication channels:
* twitter: @tainacan_l3p
***
### Important links
- Follow updates on Tainacan on [our blog](http://tainacan.org/blog/)
- Explore [our documentation](https://wiki.tainacan.org/) on our own wiki
- Join our community by signing up to [our mailing list](https://lists.riseup.net/www/info/tainacan)!
**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.
### 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.
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 on [placeholder]. If you are interested in contributing, you can get started by reading our contribution guidelines [add link to CONTRIBUTING.md].
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).
### Team