installs and npm link (#140)

README.md

@@ -6,33 +6,51 @@ _Structured extraction in Typescript, powered by llms, designed for simplicity,
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/jxnlco?style=social)](https://twitter.com/jxnlco)
 [![Twitter Follow](https://img.shields.io/twitter/follow/dimitrikennedy?style=social)](https://twitter.com/dimitrikennedy)
+[![NPM Version](https://img.shields.io/npm/v/@instructor-ai/instructor.svg)](https://www.npmjs.com/package/@instructor-ai/instructor)
 [![Documentation](https://img.shields.io/badge/docs-available-brightgreen)](https://jxnl.github.io/instructor-js)
 [![GitHub issues](https://img.shields.io/github/issues/instructor-ai/instructor-js.svg)](https://github.com/instructor-ai/instructor-js/issues)
 [![Discord](https://img.shields.io/discord/1192334452110659664?label=discord)](https://discord.gg/CV8sPM5k5Y)
 
 Dive into the world of Typescript-based structured extraction, by OpenAI's function calling API and Zod, typeScript-first schema validation with static type inference. Instructor stands out for its simplicity, transparency, and user-centric design. Whether you're a seasoned developer or just starting out, you'll find Instructor's approach intuitive and steerable.
 
-Check us out in [Python](https://jxnl.github.io/instructor/), [Elixir](https://github.com/thmsmlr/instructor_ex/) and [PHP](https://github.com/cognesy/instructor-php/).
 
-If you want to port Instructor to another language, please reach out to us on [Twitter](https://twitter.com/jxnlco) we'd love to help you get started!
+## Installation
 
-## Usage
+```bash
+bun add @instructor-ai/instructor zod openai
+```
+
+```bash
+npm i @instructor-ai/instructor zod openai
+```
+
+```bash
+pnpm add @instructor-ai/instructor zod openai
+```
 
+## Basic Usage
 To check out all the tips and tricks to prompt and extract data, check out the [documentation](https://instructor-ai.github.io/instructor-js/tips/prompting/).
 
-```ts
+
+```typescript
+
 import Instructor from "@instructor-ai/instructor";
 import OpenAI from "openai"
 import { z } from "zod"
 
+const UserSchema = z.object({
+  age: z.number(),
+  name: z.string()
+})
+
 const oai = new OpenAI({
   apiKey: process.env.OPENAI_API_KEY ?? undefined,
   organization: process.env.OPENAI_ORG_ID ?? undefined
 })
 
 const client = Instructor({
   client: oai,
-  mode: "FUNCTIONS"
+  mode: "TOOLS"
 })
 
 const UserSchema = z.object({
@@ -74,10 +92,23 @@ If you'd like to see more check out our [cookbook](examples/index.md).
 
 [Installing Instructor](docs/installation.md) is a breeze.
 
+
+
 ## Contributing
 
 If you want to help out, checkout some of the issues marked as `good-first-issue` or `help-wanted`. Found [here](https://github.com/instructor-ai/instructor-js/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cook book.
 
+Checkout the [contribution guide]() for details on how to set things up, testing, changesets and guidelines.
+
+> ℹ️ **Tip:**  Support in other languages
+
+    Check out ports to other languages below:
+
+    - [Python](https://www.github.com/jxnl/instructor)
+    - [Elixir](https://github.com/thmsmlr/instructor_ex/)
+
+    If you want to port Instructor to another language, please reach out to us on [Twitter](https://twitter.com/jxnlco) we'd love to help you get started!
+
 ## License
 
 This project is licensed under the terms of the MIT License.