Skip to content

Commit 8f27d5d

Browse files
committed
fix: Update README with badges, install, and config instructions
1 parent 44a36e8 commit 8f27d5d

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

README.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# Sleeper Fantasy Football MCP Server
22

3+
[![npm version](https://badge.fury.io/js/sleeper-mcp.svg)](https://badge.fury.io/js/sleeper-mcp)
4+
[![Downloads](https://img.shields.io/npm/dm/sleeper-mcp.svg)](https://npmjs.org/package/sleeper-mcp)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Node.js Version](https://img.shields.io/node/v/sleeper-mcp.svg)](https://nodejs.org/en/)
7+
38
A comprehensive Model Context Protocol (MCP) Server for integrating with Sleeper Fantasy Football. This server enables AI assistants like Claude to perform advanced fantasy football analysis and provide strategic recommendations.
49

10+
## 📦 Installation
11+
12+
```bash
13+
# Install globally (recommended)
14+
npm install -g sleeper-mcp
15+
16+
# Or use with npx (no installation needed)
17+
npx sleeper-mcp
18+
```
19+
520
## 🎯 What Can This Server Do?
621

722
### 📊 League Management
@@ -24,14 +39,56 @@ A comprehensive Model Context Protocol (MCP) Server for integrating with Sleeper
2439
## 🚀 Quick Start
2540

2641
### 1. Installation
42+
43+
Choose one of these installation methods:
44+
45+
#### Option A: Global NPM Install (Recommended)
46+
```bash
47+
npm install -g sleeper-mcp
48+
```
49+
50+
#### Option B: Using npx (No Installation)
2751
```bash
52+
npx sleeper-mcp
53+
```
54+
55+
#### Option C: Local Development
56+
```bash
57+
git clone https://github.com/yourusername/sleeper-mcp.git
58+
cd sleeper-mcp
2859
npm install
2960
npm run build
3061
```
3162

3263
### 2. Claude Desktop Configuration
33-
Add to your `claude_desktop_config.json`:
3464

65+
#### For Global Install or npx:
66+
```json
67+
{
68+
"mcpServers": {
69+
"sleeper-mcp": {
70+
"command": "sleeper-mcp",
71+
"args": [],
72+
"env": {}
73+
}
74+
}
75+
}
76+
```
77+
78+
#### For npx (alternative):
79+
```json
80+
{
81+
"mcpServers": {
82+
"sleeper-mcp": {
83+
"command": "npx",
84+
"args": ["sleeper-mcp"],
85+
"env": {}
86+
}
87+
}
88+
}
89+
```
90+
91+
#### For Local Development:
3592
```json
3693
{
3794
"mcpServers": {
@@ -174,7 +231,22 @@ Start a conversation with Claude and try:
174231

175232
## 🔧 Development
176233

234+
### For Users
235+
```bash
236+
# Install globally
237+
npm install -g sleeper-mcp
238+
239+
# Or use directly
240+
npx sleeper-mcp
241+
```
242+
243+
### For Contributors
177244
```bash
245+
# Clone the repository
246+
git clone https://github.com/yourusername/sleeper-mcp.git
247+
cd sleeper-mcp
248+
npm install
249+
178250
# Development with hot reload
179251
npm run dev
180252

@@ -184,6 +256,10 @@ npm start
184256

185257
# Watch mode (automatic rebuilding)
186258
npm run watch
259+
260+
# Run tests
261+
npm test
262+
npm run test:coverage
187263
```
188264

189265
## ⚠️ Limitations

0 commit comments

Comments
 (0)