Skip to content

Commit 31dd2c8

Browse files
committed
docs: Add readme warning for master
1 parent 91fd844 commit 31dd2c8

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[![Crates.io](https://img.shields.io/crates/v/protols.svg)](https://crates.io/crates/protols)
44
[![Build and Test](https://github.com/coder3101/protols/actions/workflows/ci.yml/badge.svg)](https://github.com/coder3101/protols/actions/workflows/ci.yml)
55

6+
**WARNING** : Master branch is undergoing a massive refactoring, please use last relesed tag instead.
7+
68
**Protols** is an open-source, feature-rich [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) for **Protocol Buffers (proto)** files. Powered by the efficient [tree-sitter](https://tree-sitter.github.io/tree-sitter/) parser, Protols offers intelligent code assistance for protobuf development, including features like auto-completion, diagnostics, formatting, and more.
79

810
![Protols Demo](./assets/protols.mov)
@@ -71,7 +73,7 @@ If you're using Visual Studio Code, you can install the [Protobuf Language Suppo
7173

7274
## ⚙️ Configuration
7375

74-
Protols is configured using a `protols.toml` file, which you can place in any directory. **Protols** will search for the closest configuration file by recursively traversing the parent directories.
76+
Protols is configured using a `protols.toml` file, which you can place in any directory.
7577

7678
### Sample `protols.toml`
7779

@@ -108,10 +110,6 @@ The `[formatter]` section allows configuration for code formatting.
108110

109111
- `clang_format_path`: Specify the path to the `clang-format` binary.
110112

111-
### Multiple Configuration Files
112-
113-
You can place multiple `protols.toml` files across different directories. **Protols** will use the closest configuration file by searching up the directory tree.
114-
115113
---
116114

117115
## 🛠️ Usage

0 commit comments

Comments
 (0)