Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Attacler committed Feb 2, 2023
1 parent e18058c commit d4a0a8c
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "directus-extension-texttoanything",
"version": "0.1.1",
"version": "0.1.2",
"keywords": [
"directus",
"directus-extension",
Expand Down
38 changes: 35 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,25 @@ or
yarn add directus-extension-texttoanything
```

### API
Restart your Directus instance to complete the installation of the extension.

The API is a requirement for the extension in order to eliminate dependencies specific to the operating system. Get the necessary API token at https://rapidapi.com/Attacler/api/text-to-anything. The extension will not function without it, but there is a free tier available for testing.
After restarting you will see the operations appear.
Every operation will ask for an RapidAPI Token.

Restart your Directus instance to complete the setup.
### RapidAPI Token

The RapidAPI token is a requirement for the extension in order to talk with the TextToAnything API. We are using this API to eliminate the need for dependencies.

How to obtain a RapidAPI token:

1. Go to https://rapidapi.com/Attacler/api/text-to-anything
2. Click "Sign Up" in the top right corner, or "Log in" if you already have an account
3. Click on "Subscribe to Test" or "Pricing"
4. Here you can choose the API plan that you wish to use, Basic is good enough for testing.
If you have any questions about the billing, please view the FAQ at the bottom of this page.
5. Add your payment details
You can the necessary API token at . The extension will not function without it, but there is a free tier available for testing.
6. Go to Endpoints and you should see the RapidAPI key on the right.

## Supported Features

Expand All @@ -39,3 +53,21 @@ The actions work trough flow operations and will upload the PDF/QRCode/Barcode d
The operation will return the Directus file id which you can use to link the file to a record.

If there are any questions or bugs, please create an issue.

## FAQ

1. How do i find or reset my Rapid API key?

You can find follow [this article](https://docs.rapidapi.com/docs/keys#api-key-rotation-or-resetting-a-compromised-api-key) in order to achieve this.

2. How can i stop my subscription?

[Click here](https://rapidapi.com/developer/billing/subscriptions-and-usage) if you ever want to cancel your subscription

3. Will there be more features comming?

We are currently working on making this extension a solid stable version. After that we are planning to add HTML to Image.

4. I have an issue or idea, where can i place it?

Please create an issue on [Github](https://github.com/Attacler/TextToAnything-Directus)

0 comments on commit d4a0a8c

Please sign in to comment.