From 710b75b737c3a835e3385dd72f2da0281de514bc Mon Sep 17 00:00:00 2001 From: Hermes Agent Date: Sat, 23 May 2026 10:25:40 +0000 Subject: [PATCH 1/2] docs: add Quick Start section --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index bddea39..146c75b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,28 @@ The Agentmail TypeScript library provides convenient access to the Agentmail APIs from TypeScript. + +## Quick Start + +### Installation + +```bash +npm install agentmail +``` + +### Basic Usage + +```typescript +import { AgentmailClient } from 'agentmail'; + +const client = new AgentmailClient({ apiKey: 'your-api-key' }); +const response = await client.sendMessage({ + to: 'recipient@example.com', + content: 'Hello!' +}); +console.log(response); +``` + ## Table of Contents - [Installation](#installation) From 0b9ae7c24becf448434ad213a247f00ebd9b07cc Mon Sep 17 00:00:00 2001 From: Hermes Agent Date: Sat, 23 May 2026 10:30:51 +0000 Subject: [PATCH 2/2] docs: add Quick Start guide --- README.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 146c75b..34dbefd 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,26 @@ # Agentmail TypeScript Library -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fagentmail-to%2Fagentmail-node) -[![npm shield](https://img.shields.io/npm/v/agentmail)](https://www.npmjs.com/package/agentmail) - -The Agentmail TypeScript library provides convenient access to the Agentmail APIs from TypeScript. - ## Quick Start -### Installation +Install with: +```bash +pip install agentmail-node +``` +Or clone and run: ```bash -npm install agentmail +git clone https://github.com/agentmail-to/agentmail-node.git +cd agentmail-node +python setup.py install ``` -### Basic Usage -```typescript -import { AgentmailClient } from 'agentmail'; +[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fagentmail-to%2Fagentmail-node) +[![npm shield](https://img.shields.io/npm/v/agentmail)](https://www.npmjs.com/package/agentmail) + +The Agentmail TypeScript library provides convenient access to the Agentmail APIs from TypeScript. -const client = new AgentmailClient({ apiKey: 'your-api-key' }); -const response = await client.sendMessage({ - to: 'recipient@example.com', - content: 'Hello!' -}); -console.log(response); -``` ## Table of Contents