Skip to content

Commit e55abe5

Browse files
authored
Merge pull request #9 from syncable-dev/feature/pub-creates
doc: edit readme
2 parents 5b9d1bf + 56dc090 commit e55abe5

1 file changed

Lines changed: 4 additions & 18 deletions

File tree

rust-mcp-server-syncable-cli/README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# mcp-rust-server
22

3-
[![Crates.io](https://img.shields.io/crates/v/mcp-rust-server.svg?style=for-the-badge)](https://crates.io/crates/mcp-rust-server)
4-
[![Docs.rs](https://img.shields.io/docsrs/mcp-rust-server?style=for-the-badge)](https://docs.rs/mcp-rust-server)
3+
[![Crates.io](https://img.shields.io/crates/v/mcp-rust-server.svg?style=for-the-badge)](https://crates.io/crates/rust-mcp-server-syncable-cli)
54
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)
65

76
High-performance **Model Context Protocol** (MCP) server for code analysis, security scanning, and project insights—written in Rust 🦀.
@@ -16,7 +15,6 @@ High-performance **Model Context Protocol** (MCP) server for code analysis, secu
1615
* [CLI Binaries](#cli-binaries)
1716
* [Library](#library)
1817
* [Usage](#usage)
19-
* [Examples](#examples)
2018
* [Documentation](#documentation)
2119
* [Contributing](#contributing)
2220
* [License](#license)
@@ -41,7 +39,7 @@ mcp-rust-server is published on [crates.io]. You need a recent Rust toolchain (1
4139
### CLI Binaries
4240

4341
```bash
44-
cargo install mcp-rust-server
42+
cargo install rust-mcp-server-syncable-cli
4543
```
4644

4745
This installs two binaries into your Cargo `bin` directory (usually `~/.cargo/bin`):
@@ -55,7 +53,7 @@ Add to your project’s `Cargo.toml`:
5553

5654
```toml
5755
[dependencies]
58-
mcp-rust-server = "0.1.0"
56+
rust-mcp-server-syncable-cli = "0.1.0"
5957
```
6058

6159
---
@@ -81,7 +79,7 @@ By default, both servers will:
8179
### Library
8280

8381
```rust
84-
use mcp_rust_server::{start_stdio, start_sse};
82+
use rust_mcp_server_syncable_cli::{start_stdio, start_sse};
8583

8684
#[tokio::main]
8785
async fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -100,15 +98,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
10098

10199
---
102100

103-
## Examples
104-
105-
See the \[`examples/`] directory for full end-to-end demos:
106-
107-
* `examples/stdio_client.rs` — launch `mcp-stdio` and send sample requests
108-
* `examples/sse_client.html` — web page that connects to `mcp-sse` and renders events
109-
110-
---
111-
112101
## Documentation
113102

114103
Full API documentation is generated on [docs.rs]:
@@ -117,9 +106,6 @@ Full API documentation is generated on [docs.rs]:
117106
cargo doc --open
118107
```
119108

120-
Or browse online:
121-
[https://docs.rs/mcp-rust-server](https://docs.rs/mcp-rust-server)
122-
123109
---
124110

125111
## Contributing

0 commit comments

Comments
 (0)