Skip to content

Commit

Permalink
docs(README.md): add Codecov badge to README for better visibility of…
Browse files Browse the repository at this point in the history
… test coverage

docs(README.md): add newlines for better readability in code examples and sections
  • Loading branch information
tumf committed Dec 13, 2024
1 parent 947561b commit 132b23f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MCP Text Editor Server

[![codecov](https://codecov.io/gh/tumf/mcp-text-editor/graph/badge.svg?token=52D51U0ZUR)](https://codecov.io/gh/tumf/mcp-text-editor)

A Model Context Protocol (MCP) server that provides text file editing capabilities through a standardized API.

## Features
Expand Down Expand Up @@ -232,6 +234,7 @@ Important Notes:
### Common Usage Pattern

1. Get current content and hash:

```python
contents = await get_text_file_contents({
"files": [
Expand All @@ -244,6 +247,7 @@ contents = await get_text_file_contents({
```

2. Edit file content:

```python
result = await edit_text_file_contents({
"files": [
Expand All @@ -263,6 +267,7 @@ result = await edit_text_file_contents({
```

3. Handle conflicts:

```python
if result["file.txt"]["result"] == "error":
if "hash mismatch" in result["file.txt"]["reason"]:
Expand Down Expand Up @@ -356,4 +361,4 @@ New features should include appropriate tests. Try to maintain or improve the cu

### Code Style

All code should be formatted with Black and pass Ruff linting. Import sorting should be handled by isort.
All code should be formatted with Black and pass Ruff linting. Import sorting should be handled by isort.

0 comments on commit 132b23f

Please sign in to comment.