Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hanspagel committed Jan 29, 2024
1 parent 459a0d4 commit cddfac5
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 3 deletions.
37 changes: 37 additions & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

Contributions are welcome. We’re using [pnpm](https://pnpm.io/).

Install all dependencies:
`$ pnpm install`

Run the cli:
`$ pnpm @scalar/cli --version`

Build all packages:
`$ pnpm turbo build`

We require a semantic PR title, e. g.:

```
docs: Add information about semantic commits
^ ^
| |__ Subject
|________ Prefix
```

Here are all the prefixes you need to know:

| Prefix | Description |
| -------- | ----------------------------------------------------------------------------------------------------------- |
| feat | A new feature |
| fix | A bug fix |
| docs | Documentation only changes |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| refactor | A code change that neither fixes a bug nor adds a feature |
| perf | A code change that improves performance |
| test | Adding missing tests or correcting existing tests |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Other changes that don't modify src or test files |
| revert | Reverts a previous commit |
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Scalar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
# Scalar CLI

WIP :)
[![CI](https://github.com/scalar/cli/actions/workflows/ci.yml/badge.svg)](https://github.com/scalar/cli/actions/workflows/ci.yml)
[![Release](https://github.com/scalar/cli/actions/workflows/release.yml/badge.svg)](https://github.com/scalar/cli/actions/workflows/release.yml)
[![Contributors](https://img.shields.io/github/contributors/scalar/cli)](https://github.com/scalar/cli/graphs/contributors)
[![GitHub License](https://img.shields.io/github/license/scalar/cli)](https://github.com/scalar/cli/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/8HeZcRGPFS)

Command-line interface to work with OpenAPI files

## Quickstart

```bash
npx @scalar/cli help
```

## Installation

```bash
npm install -g @scalar/cli
scalar --version
```

## Usage

```bash
scalar init
scalar format openapi.json
scalar validate openapi.json
scalar reference openapi.json
scalar mock openapi.json
scalar share openapi.json
```

## Features

* Format & validate OpenAPI files
* Upload your OpenAPI files to Scalar
* Get a fully mocked API for testing purposes
* Preview your API reference

[Full documentation](https://github.com/scalar/cli/blob/main/packages/cli/README.md)

## Community

We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/8HeZcRGPFS>

## Contributors

Contributions are welcome! Read [`CONTRIBUTING`](https://github.com/scalar/cli/blob/main/CONTRIBUTING).

## License

The source code in this repository is licensed under [MIT](https://github.com/scalar/cli/blob/main/LICENSE).
3 changes: 1 addition & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Scalar CLI

> [!CAUTION]
> WIP, not published yet
Command-line interface to work with OpenAPI files

## Installation

Expand Down

0 comments on commit cddfac5

Please sign in to comment.