@sonill/nepali-dates 1.0.3 → 1.0.6

package/README.md

@@ -1,13 +1,27 @@
 # Nepali Dates
 
-[![npm version](https://img.shields.io/npm/v/nepali-dates.svg)](https://www.npmjs.com/package/@sonill/nepali-dates)
+[![npm version](https://img.shields.io/npm/v/@sonill/nepali-dates.svg)](https://www.npmjs.com/package/@sonill/nepali-dates)
 [![Tests](https://github.com/sonill/nepali-dates/actions/workflows/test.yml/badge.svg)](https://github.com/sonill/nepali-dates/actions/workflows/test.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
 
+![nepali dates](https://repository-images.githubusercontent.com/1136702942/c66c6f7c-262c-44cd-888b-336448d2ede2)
+
 Community-driven, accurate Nepali calendar (Bikram Sambat) data and conversion utilities. A trustable source for Nepali date calculations with zero dependencies.
 
-Use this package instead of maintaining your own source of datas.
+The ultimate Nepali date conversion library for developers. Convert between Bikram Sambat (BS) and Gregorian dates with 100% accurate, community-maintained calendar data. Perfect for Nepali calendar apps, date converters, and plugins. No dependencies, fully typed, and production-ready.
+
+### Why Use This Package?
+
+Stop maintaining your own Nepali calendar data. This package eliminates the burden of:
+- Manually updating calendar data year after year
+- Debugging date conversion edge cases
+- Verifying data accuracy across multiple sources
+
+**Using JavaScript?** Use the full library with type safety and conversion utilities.
+**Using another language?** Access the calendar data directly via `calendar-data.json` in the [data/](data/) directory. Examples available for Python, PHP, Ruby, Go, and more.
+
+The community maintains the data—you focus on building great features.
 
 ## Website
 
@@ -21,25 +35,95 @@ View website  [here](https://sonill.github.io/nepali-dates/)
 - **Multiple Formats**: Support for object, ISO, string, and array formats
 - **Well-Tested**: >95% test coverage with extensive validation
 - **Community-Driven**: Open data sources and transparent validation
+- **AI Agent Ready**: MCP server available for Claude Code and other AI tools
 
 ## Installation
 
 ```bash
-npm install nepali-dates
+npm install @sonill/nepali-dates
 ```
 
 ```bash
-yarn add nepali-dates
+yarn add @sonill/nepali-dates
 ```
 
 ```bash
-pnpm add nepali-dates
+pnpm add @sonill/nepali-dates
+```
+
+## MCP Server for AI Agents
+
+This package includes a built-in MCP (Model Context Protocol) server with 9 tools for AI agents to work with Nepali calendar dates.
+
+### Setup for Claude Code
+
+Add to `~/.claude/config.json`:
+
+**Using npx (recommended - no installation required):**
+
+```json
+{
+  "mcpServers": {
+    "nepali-dates": {
+      "command": "npx",
+      "args": ["-y", "@sonill/nepali-dates", "nepali-dates-mcp"]
+    }
+  }
+}
+```
+
+**Using global installation:**
+
+```bash
+npm install -g @sonill/nepali-dates
 ```
 
+```json
+{
+  "mcpServers": {
+    "nepali-dates": {
+      "command": "nepali-dates-mcp"
+    }
+  }
+}
+```
+
+### Setup for Claude Desktop
+
+Add the same configuration to your Claude Desktop config file:
+
+- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
+- **Linux:** `~/.config/Claude/claude_desktop_config.json`
+
+After configuration, restart your AI agent and ask questions like:
+
+- "What is today's date in Nepali calendar?"
+- "Convert BS 2081/01/15 to English date"
+- "Show me the calendar for Baisakh 2081"
+
+### Available Tools
+
+- `convert_bs_to_ad`, `convert_ad_to_bs` - Date conversion
+- `get_month_calendar`, `get_year_calendar` - Calendar generation
+- `validate_bs_date`, `validate_ad_date` - Date validation
+- `navigate_month`, `get_nepali_month_name` - Navigation & localization
+- `get_current_nepali_date` - Get today's BS date
+
+### Testing
+
+Test the MCP server with the visual inspector:
+
+```bash
+npx @modelcontextprotocol/inspector npx @sonill/nepali-dates nepali-dates-mcp
+```
+
+For detailed MCP documentation, see [docs/MCP.md](docs/MCP.md).
+
 ## Quick Start
 
 ```typescript
-import { bsToAd, adToBs, getTotalDaysInMonth } from 'nepali-dates';
+import { bsToAd, adToBs, getTotalDaysInMonth } from '@sonill/nepali-dates';
 
 // Convert Nepali date to English date
 const englishDate = bsToAd(2080, 10, 15);
@@ -371,9 +455,9 @@ Thanks to all contributors and the Nepali developer community for maintaining ac
 
 ## Links
 
-- [GitHub Repository](https://github.com/yourusername/nepali-dates)
-- [Issue Tracker](https://github.com/yourusername/nepali-dates/issues)
-- [NPM Package](https://www.npmjs.com/package/nepali-dates)
+- [GitHub Repository](https://github.com/sonill/nepali-dates)
+- [Issue Tracker](https://github.com/sonill/nepali-dates/issues)
+- [NPM Package](https://www.npmjs.com/package/@sonill/nepali-dates)
 
 ---