From 2ea7cc6f5faa6305130784a2861909fe12c9b0ce Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Tue, 5 Apr 2022 14:56:16 +0200 Subject: [PATCH] Updated README to remove the template information and add simple instructions Change-Id: Ie56176144d1a9ff4810a38776a860a82a8fcfe4d Signed-off-by: garciadeblas --- README.md | 52 +++++++++++++--------------------------------------- 1 file changed, 13 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 885dfb3..54a76cf 100644 --- a/README.md +++ b/README.md @@ -12,55 +12,29 @@ implied. See the License for the specific language governing permissions and limitations under the License --> -# Project Title +# SOL003 -One Paragraph of project description goes here +This repository contains the NB specification of OSM for ETSI NFV SOL003-based API calls. ## Getting Started -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. +Install nodeJS and install the following packages using npm: -### Prerequisites - -What things you need to install the software and how to install them - -``` -Give examples -``` - -### Installing - -A step by step series of examples that tell you how to get a development env running - -Say what the step will be - -``` -Give the example +```bash +npm install --save @openapi-contrib/json-schema-to-openapi-schema +npm install -g swagger-cli +npm install -g speccy ``` -And repeat +They will be used to test if your changes are conformant to OpenAPI -``` -until finished -``` - -End with an example of getting some data out of the system or using it for a little demo - -## Running the tests - -Explain how to run the automated tests for this system +Run the following to test your changes: +```bash +./devops-stages/stage-test.sh ``` -Give an example -``` - -## Deployment - -Add additional notes about how to deploy this on a live system - -## Built With -* [Python](www.python.org/) - The language used +The script will go through all your OpenAPI files and run `swagger-cli validate` and `speccy lint` over them. ## Contributing @@ -76,5 +50,5 @@ This project is licensed under the Apache2 License - see the [LICENSE.md](LICENS ## Acknowledgments -* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) +- **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) -- 2.25.1