Skip to content

Commit

Permalink
馃摑 npm version badge
Browse files Browse the repository at this point in the history
Adds a badge with npm version. Tweaks README.
  • Loading branch information
connorjs committed Sep 9, 2023
1 parent 7d452ac commit 0bff951
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@
<!-- Badges: Use link shorthand for readability and easier reordering -->

[![CI Build][ci-build-badge]][ci-build]
[![npm version][npm-version-badge]][npm-version]

[ci-build]: https://github.com/connorjs/swapi-typespec/actions/workflows/ci-build.yml
[ci-build-badge]: https://github.com/connorjs/swapi-typespec/actions/workflows/ci-build.yml/badge.svg
[npm-version]: https://www.npmjs.com/package/swapi-typespec
[npm-version-badge]: https://img.shields.io/npm/v/swapi-typespec

<!-- End badges -->

Expand All @@ -19,7 +22,7 @@ I created this project to learn about TypeSpec through first-hand usage.

Follow these steps to consume the generated Open API specification for SWAPI.

1. Install this package as a dependency
1. Install this package as a dependency.

```sh
npm install -D swapi-typespec
Expand Down Expand Up @@ -47,7 +50,5 @@ Use `npm run` to list all available scripts. The `release` script executes a
- Using `@resource` adds _all_ REST operations. Thus, the spec files explicitly
configure `list` and `read` operations because SWAPI only supports those.

---

[swapi]: https://swapi.dev
[typespec]: https://microsoft.github.io/typespec/

0 comments on commit 0bff951

Please sign in to comment.