@oas-tools/core/README.md

OAS Tools core library

# OAS TOOLS

<div align="center">

[![NPM](https://nodei.co/npm/@oas-tools/core.png?compact=true)](https://nodei.co/npm/@oas-tools/core)

![npm](https://img.shields.io/npm/v/@oas-tools/core)
![node-current](https://img.shields.io/node/v/@oas-tools/core)
![npm](https://img.shields.io/npm/dw/@oas-tools/core)
[![Node.js CI](https://github.com/oas-tools/oas-tools/actions/workflows/nodejs.yaml/badge.svg)](https://github.com/oas-tools/oas-tools/actions/workflows/nodejs.yaml)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
<br/>

[![Known Vulnerabilities](https://snyk.io/test/github/oas-tools/oas-tools/main/badge.svg)](https://snyk.io/test/github/oas-tools/oas-tools)
[![Coverage Status](https://coveralls.io/repos/github/oas-tools/oas-tools/badge.svg?branch=main)](https://coveralls.io/github/oas-tools/oas-tools?branch=main)
</div>

> **Warning**
>
> OAS Tools package has been renamed from `oas-tools` to `@oas-tools/core`

## Quickstart

Initialize a new OAS Tools project from the CLI

```sh
> npx @oas-tools/cli init
```

It will prompt the following menu, asking which type of resource will be initialized:

```sh
? Select a resource to initialize (Use arrow keys)
> Server
  Module
  Development environment
  OpenAPI File
```
Select `server`, answer the questions and you'll get a running server with OAS Tools.

More information in our [web page](https://oas-tools.github.io)

## Contributing guidelines
We greatly appreciate community contributions, that's why we have created a document stating clear guidelines for [contributing to OAS Tools](https://github.com/oas-tools/.github/blob/main/CONTRIBUTING.md).
We also encourage you to participate in discussions and activate notification for our announcements in the organization's [discussions dashboard](https://github.com/orgs/oas-tools/discussions)

## License

Copyright 2018, [ISA Group](http://www.isa.us.es), [University of Sevilla](http://www.us.es)

For technical inquiry please contact to [engineering team](./extra/team.md).

[![ISA Group](http://www.isa.us.es/2.0/assets/img/theme/logo2.png)](http://www.isa.us.es)

Licensed under the **Apache License, Version 2.0** (the "[License](./LICENSE)"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.