Skip to content

Commit 83b3504

Browse files
committed
docs: add OpenSSF Best Practices registration badge
1 parent 271899c commit 83b3504

1 file changed

Lines changed: 28 additions & 22 deletions

File tree

README.adoc

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1+
// SPDX-License-Identifier: MPL-2.0
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
13
= Universal Language Connector
4+
image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=openssourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/universal-language-server-plugin"]
25

3-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
6+
7+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
48

59
> *One server. All editors. Universal document conversion.*
610

711
LSP-based universal plugin architecture enabling seamless document conversion across all major editors through a single, powerful Rust server.
812

9-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
13+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
1014
[![Rust](https://img.shields.io/badge/Rust-1.75+-orange.svg)](https://www.rust-lang.org/)
1115
[![LSP 3.17](https://img.shields.io/badge/LSP-3.17-green.svg)](https://microsoft.github.io/language-server-protocol/)
1216

@@ -33,18 +37,18 @@ image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,
3337
```bash
3438
= Clone repository
3539

36-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
40+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
3741
git clone https://github.com/universal-connector/universal-language-connector.git
3842
cd universal-language-connector
3943

4044
= Build and install server
4145

42-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
46+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
4347
make install
4448

4549
= Verify installation
4650

47-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
51+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
4852
universal-connector-server --version
4953
```
5054

@@ -104,7 +108,7 @@ Once configured, the connector provides:
104108
```bash
105109
= Convert document
106110

107-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
111+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
108112
curl -X POST http://localhost:8080/api/convert \
109113
-H "Content-Type: application/json" \
110114
-d '{
@@ -115,12 +119,12 @@ curl -X POST http://localhost:8080/api/convert \
115119

116120
= List documents
117121

118-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
122+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
119123
curl http://localhost:8080/api/documents
120124

121125
= Server statistics
122126

123-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
127+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
124128
curl http://localhost:8080/api/stats
125129
```
126130

@@ -192,22 +196,22 @@ The "universal" approach succeeds because:
192196
```bash
193197
= Debug build
194198

195-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
199+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
196200
make build
197201

198202
= Release build
199203

200-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
204+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
201205
make release
202206

203207
= Run tests
204208

205-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
209+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
206210
make test
207211

208212
= Start development server
209213

210-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
214+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
211215
make dev
212216
```
213217

@@ -266,20 +270,20 @@ Set via environment variables:
266270
```bash
267271
= Server addresses
268272

269-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
273+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
270274
export HTTP_ADDR="0.0.0.0:8080"
271275
export WS_ADDR="0.0.0.0:8081"
272276

273277
= Enable/disable components
274278

275-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
279+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
276280
export ENABLE_LSP="true"
277281
export ENABLE_HTTP="true"
278282
export ENABLE_WS="true"
279283

280284
= Logging
281285

282-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
286+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
283287
export RUST_LOG="info"
284288
```
285289

@@ -300,17 +304,17 @@ Each client has specific configuration. See client README:
300304
```bash
301305
= Build image
302306

303-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
307+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
304308
make docker-build
305309

306310
= Run container
307311

308-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
312+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
309313
make docker-run
310314

311315
= Or use docker-compose
312316

313-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
317+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
314318
cd deployment
315319
docker-compose up -d
316320
```
@@ -320,17 +324,17 @@ docker-compose up -d
320324
```bash
321325
= Build optimized binary
322326

323-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
327+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
324328
make production
325329

326330
= Copy to system
327331

328-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
332+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
329333
sudo cp server/target/release/universal-connector-server /usr/local/bin/
330334

331335
= Run
332336

333-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
337+
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
334338
universal-connector-server
335339
```
336340

@@ -392,7 +396,9 @@ A: The core implementation is complete and tested. Additional hardening, securit
392396

393397
== License
394398

395-
Palimpsest-MPL-1.0 License - see [LICENSE](LICENSE) for details.
399+
This project is licensed under the Mozilla Public License, v. 2.0. See the `LICENSE` file for details.
400+
401+
SPDX-License-Identifier: MPL-2.0
396402

397403
== Acknowledgments
398404

0 commit comments

Comments
 (0)