Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Commit

Permalink
Merge pull request #111 from jellyfin/fix/readme
Browse files Browse the repository at this point in the history
Fix/readme
  • Loading branch information
thornbill authored Aug 30, 2021
2 parents 96aba4e + c49393e commit 2dfaf7e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://www.npmjs.com/package/@jellyfin/client-axios">
<img alt="stable npm" src="https://img.shields.io/npm/v/@jellyfin/client-axios/stable"/>
</a>
<a href="https://www.npmjs.com/package/@jellyfin/client-axios">
<img alt="unstable npm" src="https://img.shields.io/npm/v/@jellyfin/client-axios/unstable"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-client-axios">
<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-client-axios.svg"/>
</a>
Expand All @@ -24,7 +30,7 @@
</a>
</p>

> ## WARNING: The code generated by this project is currently unusable due to a bug in the OpenAPITools generator [OpenAPITools/openapi-generator#9163](https://github.com/OpenAPITools/openapi-generator/issues/9163)
> ## WARNING: The current 10.7.7 package for this project is the one matching the 10.7.6 server API due to a bug in our deployment. New versions should be fixed and follow the server versioning.
This library is meant to help clients written in JavaScript or TypeScript interact with Jellyfin's REST API. It's generated
automatically using [OpenAPITools generator](https://github.com/OpenAPITools/openapi-generator) and it's fully typed
Expand All @@ -35,11 +41,12 @@ for TypeScript
This library depends on [Axios](https://github.com/axios/axios).

### TypeScript typings

You can also use this library as a development dependency just for the
TypeScript typings. Types are located under the ``models`` subfolder:
TypeScript typings. Types are located under the `models` subfolder:

```js
import type TYPE_NAME from '@jellyfin/client-axios/models';
import type TYPE_NAME from "@jellyfin/client-axios/models";
```

## Build Process
Expand Down Expand Up @@ -74,7 +81,7 @@ docker run --rm openapitools/openapi-generator-cli generate -i https://api.jelly
-o /output/dir
```

If you want to compile the TypeScript sources to JavaScript, check the ``README`` of the generated
If you want to compile the TypeScript sources to JavaScript, check the `README` of the generated
output, as it will contain up to date instructions of how to do it yourself.

## Examples
Expand Down

0 comments on commit 2dfaf7e

Please sign in to comment.