Skip to content

Commit f320279

Browse files
committed
Convert README.rst to README.md, add AI_ACKNOWLEDGEMENT.md
- Convert README.rst to README.md using pandoc - Reference AI_ACKNOWLEDGEMENT.md in docs/ai/index.rst toctree Note: This work was completed with AI assistance (Claude Code).
1 parent cf3965d commit f320279

3 files changed

Lines changed: 73 additions & 75 deletions

File tree

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Crossbar.io
2+
3+
*Decentralized Middleware*
4+
5+
[Crossbar.io](https://crossbar.io) is an open source networking platform
6+
for distributed and microservice applications. It implements the open
7+
Web Application Messaging Protocol (WAMP), is feature rich, scalable,
8+
robust and secure. Let Crossbar.io take care of the hard parts of
9+
messaging so you can focus on your app\'s features.
10+
11+
| [![Version](https://img.shields.io/pypi/v/crossbar.svg)](https://pypi.python.org/pypi/crossbar)
12+
[![Test](https://github.com/crossbario/crossbar/workflows/main/badge.svg)](https://github.com/crossbario/crossbar/actions?query=workflow%3Amain)
13+
[![Deploy
14+
(wheels)](https://github.com/crossbario/crossbar/workflows/deploy-wheels/badge.svg)](https://github.com/crossbario/crossbar/actions?query=workflow%3Adeploy-wheels)
15+
[![Deploy
16+
(docs)](https://github.com/crossbario/crossbar/workflows/deploy-docs/badge.svg)](https://github.com/crossbario/crossbar/actions?query=workflow%3Adeploy-docs)
17+
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://crossbar.io/docs/)
18+
19+
## Resources
20+
21+
- Download from [PyPI](https://pypi.org/project/crossbar/)
22+
- Read more on the [Project Homepage](https://crossbar.io)
23+
- Jump into the [Getting
24+
Started](https://crossbar.io/docs/Getting-Started/)
25+
- Read the reference [Documentation](https://crossbar.io/docs/)
26+
- Join the [User forum](https://crossbar.discourse.group/)
27+
- Ask a question on
28+
[StackOverflow](https://stackoverflow.com/questions/ask?tags=crossbar,wamp)
29+
- Read our [Legal
30+
Notes](https://github.com/crossbario/crossbar/blob/master/legal/README.md)
31+
32+
## Docker images
33+
34+
- [amd64](https://hub.docker.com/r/crossbario/crossbar)
35+
- [armv7](https://hub.docker.com/r/crossbario/crossbar-armhf)
36+
- [armv8](https://hub.docker.com/r/crossbario/crossbar-aarch64)
37+
38+
## JSON Schema for Crossbar.io Configuration File Format
39+
40+
We now have a JSON Schema file available for **config.json**, if you\'re
41+
using VSCode you can make use of this by adding the following to your
42+
VSCode settings; (File -\> Preferences -\> Settings)
43+
44+
``` json
45+
"json.schemas": [
46+
{
47+
"fileMatch": [
48+
"/config.json",
49+
"/.config.json"
50+
],
51+
"url": "https://raw.githubusercontent.com/crossbario/crossbar/master/crossbar.json"
52+
}
53+
],
54+
```
55+
56+
Alternatively, the generic approach is to insert a \"\$schema\" line at
57+
the top of your file;
58+
59+
``` json
60+
{
61+
"$schema": "https://raw.githubusercontent.com/crossbario/crossbar/master/crossbar.json",
62+
"version": 2,
63+
```
64+
65+
This file is currently experimental, but it should give you contextual
66+
auto-completion on all Crossbar **config.json** syntax, use CTRL+Space
67+
in VSCode to activate IntelliSense.
68+
69+
------------------------------------------------------------------------
70+
71+
*Copyright (C) 2013-2021 typedef int GmbH. All rights reserved. WAMP,
72+
Crossbar.io and XBR are trademarks of typedef int GmbH.*

README.rst

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/ai/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ should interact with this project's codebase.
99

1010
AI_POLICY.md
1111
AI_GUIDELINES.md
12+
AI_ACKNOWLEDGEMENT.md
1213
audit/AI_AUDIT_FILE.md
1314
audit/AI_AUDIT_PROCESS.md
1415
audit/AI_AUDIT_PROCESS_REVIEW.md

0 commit comments

Comments
 (0)