diff --git a/README.md b/README.md index ba4aad6..0086c86 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,36 @@ # VOTable -The VOTable library aims to provide methods to get and manage VOTables. +## Context -## Dependencies +This library aims to provide a simple way to parse and view VOTables. The goal is to make the code +reusable and as light as possible. -You need java 7 to execute EpnTAPClient. +## Usage in command-line interface -## GUI usage +### 1. Reading a VOTable from an XML file -Simply right-click on the jar and select *Open with* -> *Oracle Java 7 RunTime* (for example). + VOtableApp pathToVOTable -## CLI usage +- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`. -No CLI usage are provided for now but this is planned. \ No newline at end of file +This will display the VOTable stored in the specified XML file, through a minimalist window. + +### 2. Reading a VOTable from an on-line service + + VOtableApp targetURL type language query + +This will display the VOTable resulting the service or registry request. + +- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`; +- `language`: The language of the query, ie `ADQL`; +- `query`: The query in the specified language in double quotes, ie. `SELECT TOP 3 * FROM apis.epn_core"` + +The examples above send this query: `http://voparis-tap.obspm.fr/__system__/tap/run/tap/sync?REQUEST=doQuery&LANG=ADQL&FORMAT=votable&QUERY=SELECT%20TOP%201%2A%20FROM%20apis%2Eepn%5Fcore` + +## Usage from a Java library + +Here is a start: + + VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY); + +See the Javadoc for more informations. \ No newline at end of file diff --git a/src/main/java/eu/omp/irap/vespa/votable/README.md b/src/main/java/eu/omp/irap/vespa/votable/README.md deleted file mode 100644 index 0086c86..0000000 --- a/src/main/java/eu/omp/irap/vespa/votable/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# VOTable - -## Context - -This library aims to provide a simple way to parse and view VOTables. The goal is to make the code -reusable and as light as possible. - -## Usage in command-line interface - -### 1. Reading a VOTable from an XML file - - VOtableApp pathToVOTable - -- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`. - -This will display the VOTable stored in the specified XML file, through a minimalist window. - -### 2. Reading a VOTable from an on-line service - - VOtableApp targetURL type language query - -This will display the VOTable resulting the service or registry request. - -- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`; -- `language`: The language of the query, ie `ADQL`; -- `query`: The query in the specified language in double quotes, ie. `SELECT TOP 3 * FROM apis.epn_core"` - -The examples above send this query: `http://voparis-tap.obspm.fr/__system__/tap/run/tap/sync?REQUEST=doQuery&LANG=ADQL&FORMAT=votable&QUERY=SELECT%20TOP%201%2A%20FROM%20apis%2Eepn%5Fcore` - -## Usage from a Java library - -Here is a start: - - VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY); - -See the Javadoc for more informations. \ No newline at end of file -- libgit2 0.21.2