Skip to content

Commit

Permalink
rename NPM package to just langtail
Browse files Browse the repository at this point in the history
  • Loading branch information
rychlis committed Apr 12, 2024
1 parent 8f517bd commit 25f8d2c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 0.2.0

- Rename to just `langtail` NPM package

# 0.1.5

- Fixed an issue when passing `doNotRecord: false` as option, support for metadata fields
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# @langtail/node
# langtail SDK

[![CI check](https://github.com/langtail/langtail-node/workflows/CI%20check/badge.svg)](https://github.com/langtail/langtail-node/actions?query=workflow:"CI+check")
[![GitHub tag](https://img.shields.io/github/tag/langtail/langtail-node?include_prereleases=&sort=semver&color=blue)](https://github.com/langtail/langtail-node/releases/)
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

langtail node.js SDK
Langtail Typescript SDK

## Install

```bash
npm i @langtail/node
npm i langtail
```

## Usage
Expand All @@ -19,7 +19,7 @@ npm i @langtail/node
basic completion without any prompt. This just wraps openAI api and adds a few extra parameters you can use to affect how the request gets logged in langtail.

```ts
import { Langtail } from "@langtail/node"
import { Langtail } from "langtail"

const lt = new Langtail({
apiKey: "<LANGTAIL_API_KEY>",
Expand Down Expand Up @@ -60,7 +60,7 @@ Of course this assumes that you have already deployed your prompt to `staging` e
In case you only need deployed prompts, you can import just `LangtailPrompts` like this:

```ts
import { LangtailPrompts } from "@langtail/node"
import { LangtailPrompts } from "langtail"

const lt = new LangtailPrompts({
apiKey: "<LANGTAIL_API_KEY>",
Expand All @@ -80,7 +80,7 @@ this way whole `LangtailNode` can get tree shaken away.
You can initialize LangtailPrompts with workspace and project slugs like so:

```ts
import { Langtail } from "@langtail/node"
import { Langtail } from "langtail"

const lt = new Langtail({
apiKey: "<LANGTAIL_API_KEY>",
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@langtail/node",
"version": "0.1.5",
"name": "langtail",
"version": "0.2.0",
"description": "",
"main": "./dist/LangtailNode.js",
"packageManager": "[email protected]",
Expand Down

0 comments on commit 25f8d2c

Please sign in to comment.