Skip to content

Commit

Permalink
docs(firmhouse-sdk): update SDK docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fthts committed Jun 17, 2024
1 parent 8c3ca73 commit 8737876
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## SDK

You can find the SDK documentation [here](./packages/firmhouse-sdk/README.md).
You can find the SDK project [here](./packages/firmhouse-sdk/README.md).

## Example Apps

Expand Down
16 changes: 15 additions & 1 deletion packages/firmhouse-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# firmhouse-sdk
# Firmhouse SDK

A JavaScript / TypeScript SDK for interacting with the Firmhouse GraphQL API in a structured and type-safe way.

The Firmhouse SDK is designed to make it easier for developers to interact with the Firmhouse API by providing a fully typed interface and handling errors in a structured way.

## Features

- Fully typed SDK with TypeScript, so you don't have to worry about field names and types.
- Provides smooth IDE experience with auto-completion and type hints.
- Handles errors in a structured way.
- Supports both Storefront and Write access tokens and restricts operations based on the access type.
- Gives you the option to include/exclude related resources in the response, without writing messy GraphQL queries.

## Install

```bash
npm install @firmhouse/firmhouse-sdk
Expand Down
2 changes: 1 addition & 1 deletion packages/firmhouse-sdk/release.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module.exports = {
tagFormat: `${name}-v\${version}`,
commitPaths: [`${srcRoot}/*`],
branches: [
'main',
{ name: 'main' },
{ name: 'beta', prerelease: true },
{ name: 'alpha', prerelease: true },
],
Expand Down

0 comments on commit 8737876

Please # to comment.