mirror of
https://github.com/samanhappy/mcphub.git
synced 2025-12-24 02:39:19 -05:00
update README to reflect project name change and simplify content
This commit is contained in:
37
README.md
37
README.md
@@ -1,11 +1,6 @@
|
||||
# Server Insure
|
||||
# MCP Hub
|
||||
|
||||
A TypeScript server for insurance services.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js (v14+)
|
||||
- npm or yarn
|
||||
A hub server for mcp servers.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -19,31 +14,3 @@ A TypeScript server for insurance services.
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Available Scripts
|
||||
|
||||
- `npm run build` - Compiles TypeScript to JavaScript
|
||||
- `npm run start` - Starts the server from compiled JavaScript
|
||||
- `npm run dev` - Starts the development server with hot reloading
|
||||
- `npm run lint` - Runs ESLint to check for code quality
|
||||
- `npm run format` - Formats code using Prettier
|
||||
- `npm run test` - Runs tests using Jest
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
mcphub/
|
||||
├── src/ # Source code
|
||||
│ ├── routes/ # API routes
|
||||
│ └── index.ts # Entry point
|
||||
├── dist/ # Compiled JavaScript (generated)
|
||||
├── .env # Environment variables (create from .env.example)
|
||||
├── package.json # Project dependencies and scripts
|
||||
└── tsconfig.json # TypeScript configuration
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- GET /api/insurance - Get all insurance policies
|
||||
- GET /api/insurance/:id - Get a specific insurance policy
|
||||
- POST /api/insurance - Create a new insurance policy
|
||||
|
||||
Reference in New Issue
Block a user