Skip to content

Commit

Permalink
🌿 update casing in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fern-bot authored May 28, 2024
1 parent 1cc20d1 commit 65b6f67
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# FileForge TypeScript Library
# Fileforge TypeScript Library

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/)

The FileForge TypeScript library provides convenient access to the FileForge API from JavaScript/TypeScript.
The Fileforge TypeScript library provides convenient access to the Fileforge API from JavaScript/TypeScript.

## Documentation

Expand All @@ -11,18 +11,18 @@ API reference documentation is available [here](https://fileforge.docs.buildwith
## Installation

```bash
npm install --save fileforge
npm install --save @fileforge/client
# or
yarn add fileforge
yarn add @fileforge/client
```

## Usage

```typescript
import { FileForgeClient, FileForge } from "guesty";
import { FileforgeClient, Fileforge } from "@fileforge/client";
import * as fs from "fs";

const fileforge = new FileForgeClient({
const fileforge = new FileforgeClient({
apiKey: "...",
});

Expand All @@ -37,15 +37,15 @@ await fileforge.generate({
## Exception Handling

When the API returns a non-success status code (4xx or 5xx response),
a subclass of [FileForgeError](./src/errors/FileForgeError.ts) will be thrown:
a subclass of [FileforgeError](./src/errors/FileforgeError.ts) will be thrown:

```ts
import { FileForgeError } from 'fileforge';
import { FileforgeError } from '@fileforge/client';

try {
await fileforge.generate(...);
} catch (err) {
if (err instanceof FileForgeError) {
if (err instanceof FileforgeError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
Expand Down Expand Up @@ -105,9 +105,9 @@ running in an unsupported environment, this provides a way for you to break the
ensure the SDK works.

```ts
import { FileForge } from 'fileforge';
import { Fileforge } from '@fileforge/client';

const guesty = new FileForge({
const guesty = new Fileforge({
apiKey: "...",
fetcher: // provide your implementation here
});
Expand Down

0 comments on commit 65b6f67

Please sign in to comment.