Skip to content

Commit b0430e6

Browse files
committed
chore: update README.md
1 parent 68608b6 commit b0430e6

File tree

1 file changed

+6
-32
lines changed

1 file changed

+6
-32
lines changed

README.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ This repository contains the source code for Node.js SDKs that help you enforce
2525
[![Join the chat at https://discord.gg/wso2](https://img.shields.io/badge/Join%20us%20on-Discord-%23e01563.svg)](https://discord.gg/wso2)
2626
[![Follow Asgardeo on Twitter](https://img.shields.io/twitter/follow/Asgardeo?style=social&label=Follow%20Asgardeo)](https://twitter.com/intent/follow?screen_name=Asgardeo)
2727

28+
## Quickstart
29+
30+
For Express.js applications, we recommend using the @brionmario-experimental/mcp-express package.
31+
32+
To get started quickly with Express.js, please refer to the [README.md](./packages/mcp-express/README.md) for mcp-express.
33+
2834
## Packages
2935

3036
| Package | Description |
@@ -43,38 +49,6 @@ The Model Context Protocol (MCP) is designed to provide a standardized way for a
4349

4450
For detailed installation and usage instructions for each package, please refer to the README file within its respective directory (e.g., `packages/mcp-express/README.md`).
4551

46-
## Prerequisites
47-
48-
Before you begin, ensure you have the following prerequisites installed:
49-
- Node.js `16.x` or later
50-
- pnpm `8.x` or later (or your preferred package manager like npm/yarn, though pnpm is often used in monorepos)
51-
52-
## Development
53-
54-
To get started with development:
55-
56-
1. **Clone the repository:**
57-
```bash
58-
git clone [https://github.com/brionmario/asgardeo-mcp-node.git](https://github.com/brionmario/asgardeo-mcp-node.git)
59-
cd asgardeo-mcp-node
60-
```
61-
62-
2. **Install dependencies:**
63-
If you are using pnpm and have a workspace setup:
64-
```bash
65-
pnpm install
66-
```
67-
This will typically install dependencies for all packages in the monorepo.
68-
69-
3. **Build packages:**
70-
You will likely have a root-level build command or individual build commands per package. Example using pnpm workspaces:
71-
```bash
72-
pnpm run build
73-
# or to build a specific package
74-
# pnpm --filter @brionmario-experimental/mcp-express run build
75-
```
76-
77-
Please refer to the `package.json` scripts and individual package READMEs for more detailed development commands.
7852

7953
## Contribute
8054

0 commit comments

Comments
 (0)