Commit 48e2aaf7 authored by Nathan Chambron's avatar Nathan Chambron
Browse files

ReadMe update

parent 7f9a9e71

README.md

+8 −8
Original line number Original line Diff line number Diff line
@@ -13,17 +13,17 @@ 




## Description

## Description





This repo contains the API specification needed to generate a pistache server library.

This repo contains a pistache server library generation pipeline compliant to the World Storage API.

It also contains a sample using that library, it's a basic implementation allowing the user to perform all CRUD operations on the Trackable model

It also contains a sample using that library, it's a basic implementation allowing the user to perform all CRUD operations on the Trackable models.





## Repo Content

## Repo Content





|   |  File / Folder |                                                                                    Description                                                                                    |

|   |  File / Folder |                                                                                    Description                                                                                    |

|--------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

|:-:|:--------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

| :open_file_folder: | EtsiServerGen  | The folder where the library code will be generated,  the openapi generator is set to not overwrite the CmakeLists.txt  used to generate and export the library to the user's sytem |

| 📂 | EtsiServerGen  | The folder where the library code will be generated, the openapi generator is set to not overwrite the CmakeLists.txt used to generate and export the library to the user's sytem |

| :open_file_folder: | EtsiServerImpl | This folder contains a basic implementation of this library, its main set up a local hosted server on port 8080 waiting for CRUD  REST queries on the object Trackable              |

| 📂 | EtsiServerImpl | This folder contains a basic implementation of this library, its main set up a local hosted server on port 8080 waiting for CRUD REST queries on the Trackable objects             |

| :page_with_curl:   | openapi.yaml   | The api specification file                                                                                                                                                          |

| 📂 | arf005         | A submodule pointing to the git containing the API specification file                                                                                                             |

| :page_with_curl:   | package.json   | The file containing the npm scripts automating the whole  library generation process                                                                                                |

| 📃 | package.json   | The file containing the npm scripts automating the whole library generation process                                                                                               |





## Requirements

## Requirements