aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlban Peignier2018-05-06 22:36:02 +0200
committerAlban Peignier2018-05-06 22:36:02 +0200
commit343133fc64d100d16b584d4ab60d641c56965ca2 (patch)
tree33165f3840a8bb5a525058e7667fc7e1dd652aef
parent9ffe6440e239883f5e268c199ca891ad90fd4c59 (diff)
downloadchouette-core-343133fc64d100d16b584d4ab60d641c56965ca2.tar.bz2
Update README.md for chouette-core. Refs #6958
-rw-r--r--README.md33
1 files changed, 10 insertions, 23 deletions
diff --git a/README.md b/README.md
index 83ede1b13..752424c18 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,38 @@
-# Chouette2 [![Build Status](https://travis-ci.org/afimb/chouette2.svg?branch=master)](https://travis-ci.org/afimb/chouette2) [![Dependency Status](https://gemnasium.com/afimb/chouette2.png)](https://gemnasium.com/afimb/chouette2) [![Code Climate](https://codeclimate.com/github/afimb/chouette2.png)](https://codeclimate.com/github/afimb/chouette2)
+# Chouette
-Chouette2 is an open source web project in Ruby/Rails to edit and view transport offer data. It is designed as an [SaaS](http://en.wikipedia.org/wiki/Software_as_a_service) platform and can :
+Chouette is a Ruby/Rails & Java project to manage transport offer data. It is designed as an [SaaS](http://en.wikipedia.org/wiki/Software_as_a_service) platform and can :
* Exchange transport data
* [Neptune](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/neptune/),
* [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr),
* [NeTEx](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/netex/)
-* Edit transport data
+* Create and edit transport data with a collaborative team workflow
* Be requested via a read-only [Restful API](https://en.wikipedia.org/wiki/Representational_state_transfer)
* [Import, Export and Validate transport data asynchronously](http://github.com/afimb/chouette)
* Use a [multi-tenancy database](http://en.wikipedia.org/wiki/Multitenancy)
-Release Notes
--------------
+Chouette Core
+------------
+
+Chouette Core is the developer version of Chouette open source project. Use this projet to fork and maintain your own Chouette project.
-The release notes (in French) can be found in the [CHANGELOG](./CHANGELOG.md) file
+**Chouette Core is under construction**, contact [af83 Choutte team](mailto:chouette-dev@af83.com) if you have any question.
Requirements
------------
-* [Import, Export and Validation Operations](https://github.com/af83/stif-boiv-iev) are in another project in Java
-
-Install
--------
-
-See [installation manual](./INSTALL.md)
+* [Import, Export and Validation Operations](https://github.com/af83/chouette-core-iev) are in the Java part of the project
More Information
----------------
Some technical articles are available [on the wiki](../../wiki) too.
-API Documentation
------------------
-
-TODO
-
License
-------
This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](./LICENSE.md) file.
-Release Notes
--------------
-
-The release notes (in French) can be found in [CHANGELOG](./CHANGELOG.md) file
-
Support
-------
-Users looking for support should file an issue on the GitHub [issue tracking page](../../issues), or file a [pull request](../../pulls) if you have a fix available.
+Contact [af83 Choutte team](mailto:chouette-dev@af83.com) to know how to contribute to the Chouette project