Skip to content

Commit b016ccb

Browse files
committed
docs: add README.md
Signed-off-by: Shane Utt <shaneutt@linux.com>
1 parent 85da799 commit b016ccb

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# Praxis
22

3-
The cloud and AI-native proxy server.
3+
[![Tests](https://github.com/shaneutt/praxis/actions/workflows/tests.yaml/badge.svg)](https://github.com/shaneutt/praxis/actions/workflows/tests.yaml)
4+
[![Conformance](https://github.com/shaneutt/praxis/actions/workflows/conformance.yaml/badge.svg)](https://github.com/shaneutt/praxis/actions/workflows/conformance.yaml)
5+
[![Supply Chain](https://github.com/shaneutt/praxis/actions/workflows/supply-chain.yaml/badge.svg)](https://github.com/shaneutt/praxis/actions/workflows/supply-chain.yaml)
6+
[![MSRV: 1.94](https://img.shields.io/badge/MSRV-1.94-brightgreen.svg)](https://blog.rust-lang.org/)
7+
[![License: LGPL-3.0-only](https://img.shields.io/badge/license-LGPL--3.0--only-blue.svg)](LICENSE)
8+
9+
Praxis is a high performance proxy server and framework for AI and cloud-native workloads.
10+
11+
## Getting Started
12+
13+
- [Quickstart](docs/quickstart.md)
14+
- [Features](docs/features.md)
15+
- [Configuration](docs/configuration.md)
16+
- [Example configs](examples/README.md)
17+
18+
## Documentation
19+
20+
- [Filters](docs/filters.md)
21+
- [Extensions](docs/extensions.md)
22+
- [TLS](docs/tls.md)
23+
24+
### Contributing
25+
26+
Please feel free to create issues.
27+
28+
Pull requests are on hold temporarily, but will be enabled soon.
29+
30+
See the relevant documentation:
31+
32+
- [Architecture](docs/architecture.md)
33+
- [Development](docs/development.md)
34+
- [Benchmarks](docs/benchmarks.md)

0 commit comments

Comments
 (0)