Skip to content

Commit

Permalink
docs: Updates readme and removes old release code
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobo committed Oct 30, 2024
1 parent c5f776f commit 195b448
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Take control of your third party APIs

# Getting Started

You'll need your API key from taskless.io to use Taskless' dynamic pack loading, remote cofiguration, and dashboard packages. If you don't have an API key, you can sign up for free at [taskless.io](https://taskless.io).

```bash
npm install @taskless/loader
# or
Expand All @@ -17,18 +15,26 @@ pnpm add @taskless/loader
Once you've installed the Taskless loader into your node dependencies, it's as easy as:

```bash
TASKLESS_API_KEY="your api key" node --import="@taskless/loader" start.js
node --import="@taskless/loader" start.js
```

# Advanced Features

## Taskless Cloud

You'll need your API key from taskless.io to use Taskless' dynamic pack loading, remote cofiguration, and dashboard packages. If you don't have an API key, you can request one at [taskless.io](https://taskless.io). With an API key in hand, you can update your node.js start command:

```bash
TASKLESS_API_KEY="your api key" node --import="@taskless/loader" start.js
```

## Autoloading Options

| env | values | description |
| :------------------- | :------------------------------- | :---------------------------------------------- |
| `TASKLESS_API_KEY` | `string` | Your Taskless API key |
| `TASKLESS_LOG_LEVEL` | `debug`, `info`, `warn`, `error` | Sets the log level |
| `TASKLESS_OPTIONS` | `key1=value1;key2=value2...` | Set key/value pairs for the Taskless Autoloader |
| env | values | description |
| :------------------- | :---------------------------------------- | :---------------------------------------------- |
| `TASKLESS_API_KEY` | `string` | Your Taskless API key |
| `TASKLESS_LOG_LEVEL` | `trace`, `debug`, `info`, `warn`, `error` | Sets the log level |
| `TASKLESS_OPTIONS` | `key1=value1;key2=value2...` | Set key/value pairs for the Taskless Autoloader |

## Programatic API

Expand Down
7 changes: 0 additions & 7 deletions RELEASING.md

This file was deleted.

0 comments on commit 195b448

Please sign in to comment.