Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
RodriSanchez1 committed Mar 7, 2024
1 parent 42a4e13 commit 6918fa6
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The images are retrieved from the [Global Symbols](https://www.globalsymbols.com
- [Installation](#installation)
- [Usage](#usage)
- [Initialization](#initialization)
- [Types](#types)
- [Methods](#methods)
- [getSuggestionsAndProcessPictograms](#getSuggestionsAndProcessPictograms)
- [getSuggestions](#getSuggestions)
Expand Down Expand Up @@ -78,7 +79,7 @@ const openAIConfiguration = {

- `globalSymbolsApiURL`: The Global Symbols API URL. Default is `https://www.globalsymbols.com/api/v1/labels/search/`. Optional.

- `pictonizerConfiguration`: Object with the Pictonizer configuration. Optional. If not passed, the `pictonizer()` method will return a "empty" image. For more info see below.
- `pictonizerConfiguration`: Object with the Pictonizer configuration. Optional. If not passed, the `pictonizer()` method will return a "empty" image. For more info see [pictonizer](#pictonizer).

```typescript
import { type PictonizerConfiguration } from "cboard-ai-engine";
Expand Down Expand Up @@ -225,10 +226,11 @@ const AIImage = {
prompt: "Brazilian food arasaac pictograms";
}

// NOTE: The prompt is a concatenation of the prompt and the keyWords from the PictonizerConfiguration.
// NOTE: The prompt is a concatenation of the prompt
// and the keyWords from the PictonizerConfiguration.
```

If no URL or Token is passed on the `PictonizerConfiguration` parameter, it will return:
If no URL or Token is passed on the `PictonizerConfiguration` parameter, or occurs an error while generating. It will return:

```javascript
const AIImage = {
Expand All @@ -238,7 +240,8 @@ const AIImage = {
prompt: "Brazilian food arasaac pictograms";
}

// NOTE: The prompt is a concatenation of the prompt and the keyWords from the PictonizerConfiguration.
// NOTE: The prompt is a concatenation of the prompt
// and the keyWords from the PictonizerConfiguration.
```

And no error will be thrown.
Expand Down

0 comments on commit 6918fa6

Please sign in to comment.