# Project Name

> One-line description of what this library does

[![Build Status][build-badge]][build-link]
[![npm version][npm-badge]][npm-link]
[![License][license-badge]][license-link]

## TL;DR

What it does in 2-3 sentences. Who should use it.

## Quick Start

### Install

```bash
npm install package-name
```

### Use

```javascript
const lib = require('package-name');

// Basic usage example
const result = lib.doSomething();
console.log(result);
```

## When to Use This

- ✅ When you need X functionality
- ✅ When you want Y capability
- ❌ When you need Z (use [alternative] instead)

## API Reference

### `doSomething(options)`

Description of the main method.

**Parameters:**

- `options` (Object): Configuration options
  - `param1` (string): Description of parameter
  - `param2` (boolean, optional): Description of optional parameter

**Returns:** Description of return value

**Example:**

```javascript
const result = lib.doSomething({
  param1: 'value',
  param2: true,
});
```

## Full Documentation

[Link to full documentation](./)

## Contributing

We welcome contributions! Please see [CONTRIBUTING.md](https://github.com/tosin2013/mcp-adr-analysis-server/blob/main/CONTRIBUTING.md) for guidelines.

## License

MIT License - see [../LICENSE](../LICENSE) file for details.

[build-badge]: https://github.com/username/repo/workflows/CI/badge.svg
[build-link]: https://github.com/username/repo/actions
[npm-badge]: https://img.shields.io/npm/v/package-name.svg
[npm-link]: https://www.npmjs.com/package/package-name
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license-link]: ../LICENSE
