Skip to content

Commit 56c37fc

Browse files
committed
updating README
1 parent ef3599d commit 56c37fc

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,28 @@ The tool is inspired in the research papers:
1616
What can you find in this repository?
1717
-------------------------------------
1818

19-
So far, these are the projects:
19+
So far, these are the projects (all of them developed as Eclipse plugins):
2020

21-
* **jsonDiscoverer**. Includes the core implementation of the discoverers to get Ecore models from JSON documents.
22-
* **jsonDiscoverer.coverage**. EMF-generated Java Code defining an Ecore model to represent coverage models.
23-
* **jsonDiscoverer.web**. Web project including (1) an angularJS-based client-side application and (2) a servlet-based server-side application to provide access to the discoverers.
21+
* **jsonDiscoverer**. Includes the core implementation of the discoverers to get schemas (and data models) out of JSON documents. Schemas are represented as Ecore files while data models are XMI files conforming to the Ecore ones. This means that the tool depends on [Eclipse Modeling Framework](https://eclipse.org/modeling/emf/).
22+
* **jsonDiscoverer.coverage**. EMF-generated Java Code from an Ecore model to represent coverage models. Coverage models are used to specify which parts in a general Ecore model are covered by smaller Ecore models.
23+
* **jsonDiscoverer.web**. Web project including (1) an angularJS-based client-side application and (2) a servlet-based server-side application to provide access to the discoverers. Servlets are basically the facade to the discoverers implemented in the jsonDiscoverer project.
2424
* **jsonDiscoverer.tests**. Includes some JUnit-based classes to test the discoverers.
2525
* **jsonDiscoverer.examples**. Includes some code examples to launch the discoverers.
2626
* **jsonDiscoverer.zoo**. Some JSON documents collected from several Web APIs to test the discoverers.
2727

2828
The project uses the [GSON library](https://github.com/google/gson) to parse JSON documents.
2929

30+
Using JSONDiscoverer
31+
---
32+
You can use the tool in three ways:
33+
* **Accesing the tool website**. The easiest to use our tool is to access to the [webpage of the project](http://som-research.uoc.edu/tools/jsonDiscoverer)
34+
* **In Java**. You can directly use the Java implementation of the discoverers provided in the jsonDiscoverer project. Refer to project jsonDiscoverer.examples to see some Java example code to use the discoverers
35+
* **As Web application**. You can create the WAR container file out of the jsonDiscoverer.web project and deploy it in your Tomcat (currently tested in Tomcat 7). The WAR is not provided because some tuning has to be made, in particular, see the file `config.properties` located in the `WebContent/WEB-INF`folder
36+
37+
Can I collaborate?
38+
---
39+
Absolutely!. This project is licensed under the EPL license so feel free to contribute. You can find our (simple) governance rules in this [file](https://github.com/SOM-Research/jsonDiscoverer/blob/master/governance.md)
40+
3041
Who is behind this project?
3142
---------------------------
3243
* [Javier Canovas](http://github.com/jlcanovas/ "Javier Canovas")

0 commit comments

Comments
 (0)