From 195b448be04f23741ebbd044c096794e57c6f175 Mon Sep 17 00:00:00 2001 From: Jakob Heuser Date: Tue, 29 Oct 2024 17:45:45 -0700 Subject: [PATCH] docs: Updates readme and removes old release code --- README.md | 22 ++++++++++++++-------- RELEASING.md | 7 ------- 2 files changed, 14 insertions(+), 15 deletions(-) delete mode 100644 RELEASING.md diff --git a/README.md b/README.md index 6214852..351d947 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/RELEASING.md b/RELEASING.md deleted file mode 100644 index 6ad95fc..0000000 --- a/RELEASING.md +++ /dev/null @@ -1,7 +0,0 @@ -# Releasing using `release-it` - -This repository releases code using [release-it](https://github.com/release-it/release-it). New releases can be triggered from the root package via `pnpm rel` which offers a guided process. - -## Common Commands - -- Publish: `pnpm changeset publish`