jellyfin/jellyfin-sdk-swift
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-sdk-swift.git synced 2024-11-23 06:09:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ethan Pippin 2022-08-17 15:11:52 -06:00
parent fd3286bcd2
commit 4533a1358b
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -14,20 +14,17 @@ let jellyfinClient = JellyfinClient(configuration: configuration)
let response = jellyfinClient.signIn(username: "jelly", password: "fin") let response = jellyfinClient.signIn(username: "jelly", password: "fin")
``` ```
## Documentation
- [ ] TODO: host .doccarchive on GH Pages
## Generation ## Generation
Generating and updating the Entities, Extensions, and Paths with CreateAPI is provided as an Xcode command plugin. Generating and updating the **Entities**, **Extensions**, and **Paths** with CreateAPI is provided as an Xcode command plugin.
1. Download [the latest Jellyfin schema](https://api.jellyfin.org/openapi/jellyfin-openapi-stable.json) 1. Download [the latest Jellyfin schema](https://api.jellyfin.org/openapi/jellyfin-openapi-stable.json)
2. Move the schema to **/Sources** 2. Move the schema to **/Sources**
3. Delete the current Entities, Extensions, and Paths folders 3. Delete the current **Entities**, **Extensions**, and **Paths** directories
4. Run the following command in the repo directory: 4. Run the following command in the package directory:
```bash
# runs the CreateAPI Xcode command plugin
$ swift package --allow-writing-to-package-directory generate-api
``` ```
swift package --allow-writing-to-package-directory generate-api 5. New **Entities**, **Extensions**, and **Paths** directories should be available within the package
```
5. New Entities, Extensions, and Paths folders should be generated within the package.