Skip to content

Commit 9b6cf66

Browse files
committed
Add license badges to README
1 parent 90fbe8e commit 9b6cf66

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
= Universal Language Connector
22

3+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
4+
35
> *One server. All editors. Universal document conversion.*
46

57
LSP-based universal plugin architecture enabling seamless document conversion across all major editors through a single, powerful Rust server.
@@ -30,13 +32,19 @@ LSP-based universal plugin architecture enabling seamless document conversion ac
3032

3133
```bash
3234
= Clone repository
35+
36+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
3337
git clone https://github.com/universal-connector/universal-language-connector.git
3438
cd universal-language-connector
3539

3640
= Build and install server
41+
42+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
3743
make install
3844

3945
= Verify installation
46+
47+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
4048
universal-connector-server --version
4149
```
4250

@@ -95,6 +103,8 @@ Once configured, the connector provides:
95103

96104
```bash
97105
= Convert document
106+
107+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
98108
curl -X POST http://localhost:8080/api/convert \
99109
-H "Content-Type: application/json" \
100110
-d '{
@@ -104,9 +114,13 @@ curl -X POST http://localhost:8080/api/convert \
104114
}'
105115

106116
= List documents
117+
118+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
107119
curl http://localhost:8080/api/documents
108120

109121
= Server statistics
122+
123+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
110124
curl http://localhost:8080/api/stats
111125
```
112126

@@ -177,15 +191,23 @@ The "universal" approach succeeds because:
177191

178192
```bash
179193
= Debug build
194+
195+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
180196
make build
181197

182198
= Release build
199+
200+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
183201
make release
184202

185203
= Run tests
204+
205+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
186206
make test
187207

188208
= Start development server
209+
210+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
189211
make dev
190212
```
191213

@@ -243,15 +265,21 @@ Set via environment variables:
243265

244266
```bash
245267
= Server addresses
268+
269+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
246270
export HTTP_ADDR="0.0.0.0:8080"
247271
export WS_ADDR="0.0.0.0:8081"
248272

249273
= Enable/disable components
274+
275+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
250276
export ENABLE_LSP="true"
251277
export ENABLE_HTTP="true"
252278
export ENABLE_WS="true"
253279

254280
= Logging
281+
282+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
255283
export RUST_LOG="info"
256284
```
257285

@@ -271,12 +299,18 @@ Each client has specific configuration. See client README:
271299

272300
```bash
273301
= Build image
302+
303+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
274304
make docker-build
275305

276306
= Run container
307+
308+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
277309
make docker-run
278310

279311
= Or use docker-compose
312+
313+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
280314
cd deployment
281315
docker-compose up -d
282316
```
@@ -285,12 +319,18 @@ docker-compose up -d
285319

286320
```bash
287321
= Build optimized binary
322+
323+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
288324
make production
289325

290326
= Copy to system
327+
328+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
291329
sudo cp server/target/release/universal-connector-server /usr/local/bin/
292330

293331
= Run
332+
333+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
294334
universal-connector-server
295335
```
296336

0 commit comments

Comments
 (0)