Skip to content

Commit 5feb6c4

Browse files
authored
Merge pull request #52 from karthik2804/add_readme_to_types
Add a readme to the npm package
2 parents 6ab3ef0 + 517e742 commit 5feb6c4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

types/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Type definitions for spin-js-sdk
2+
3+
This package provides the type definitions for building apps with TypeScript using `spin-js-sdk`.
4+
5+
### Adding the package to your project
6+
7+
```
8+
npm install --save-dev @fermyon/spin-sdk-types
9+
```
10+
### Importing the types into TypeScript
11+
12+
Add the following import to your source file:
13+
14+
```
15+
import { HandleRequest, HttpResponse } from "@fermyon/spin-sdk-types"
16+
```
17+
18+
### Reporting bugs
19+
20+
In the case of bugs in the package, please open an [issue](https://github.com/fermyon/spin-js-sdk/issues/new/choose).

0 commit comments

Comments
 (0)