Skip to content

Commit cca0a09

Browse files
authored
docs: improve readme
1 parent ba90d0f commit cca0a09

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
</p>
2323

2424

25-
## Installation
25+
# ⬇️ Installation
2626

2727
```bash
2828
npm install --save-dev @codelytv/mcp-client
2929
```
3030

31-
## Usage
31+
# 💻 Usage
3232

33-
### Basic Example
33+
## Basic Example
3434

3535
```typescript
3636
import { McpClient } from '@codelytv/mcp-client';
@@ -60,23 +60,23 @@ const resource = await mcpClient.readResource('courses://all');
6060
await mcpClient.disconnect();
6161
```
6262

63-
### HTTP Transport
63+
## HTTP Transport
6464

6565
```typescript
6666
const mcpClient = new McpClient("http", ["http://localhost:3000/mcp"]);
6767
```
6868

69-
## API
69+
# 🔡 API
7070

71-
### McpClient
71+
## McpClient
7272

7373
The main client class for interacting with MCP servers.
7474

75-
#### Constructor
75+
### Constructor
7676

7777
- `new McpClient(transport: "stdio" | "http", args: string[])`
7878

79-
#### Methods
79+
### Methods
8080

8181
- `connect()` - Connect to the MCP server
8282
- `disconnect()` - Disconnect from the MCP server
@@ -89,7 +89,7 @@ The main client class for interacting with MCP servers.
8989
- `listPrompts()` - List available prompts
9090
- `getPrompt(name: string, args?: Record<string, unknown>)` - Get a prompt
9191

92-
## Codely Code Quality Standards
92+
# 👌 Codely Code Quality Standards
9393

9494
Publishing this package we are committing ourselves to the following code quality standards:
9595

@@ -100,6 +100,6 @@ Publishing this package we are committing ourselves to the following code qualit
100100
- 📖 **Well documented ReadMe** showing how to install and use
101101
- ⚖️ **License favoring Open Source** and collaboration
102102

103-
## License
103+
# ⚖️ License
104104

105105
See [LICENSE](LICENSE)

0 commit comments

Comments
 (0)