diff --git a/README.md b/README.md index 55ae7c2dd..1baacb5ce 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,39 @@ -[![release](https://img.shields.io/github/release/osapi-io/osapi.svg?style=for-the-badge)](https://github.com/osapi-io/osapi/releases/latest) -[![codecov](https://img.shields.io/codecov/c/github/osapi-io/osapi?token=NF0T86B1EP&style=for-the-badge)](https://codecov.io/gh/osapi-io/osapi) -[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](LICENSE) -[![build](https://img.shields.io/github/actions/workflow/status/osapi-io/osapi/go.yml?style=for-the-badge)](https://github.com/osapi-io/osapi/actions/workflows/go.yml) -[![docker](https://img.shields.io/badge/ghcr.io-osapi-blue?style=for-the-badge&logo=docker&logoColor=white)](https://github.com/osapi-io/osapi/pkgs/container/osapi) -[![cosign](https://img.shields.io/badge/signed-cosign-blueviolet?style=for-the-badge&logo=sigstore&logoColor=white)](https://osapi-io.github.io/osapi/#docker) -[![sbom](https://img.shields.io/badge/SBOM-attached-green?style=for-the-badge)](https://github.com/osapi-io/osapi/actions/workflows/docker-publish.yml) -[![powered by](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=for-the-badge)](https://github.com/goreleaser) -[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org) -![openapi initiative](https://img.shields.io/badge/openapiinitiative-%23000000.svg?style=for-the-badge&logo=openapiinitiative&logoColor=white) -![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) -![gitHub commit activity](https://img.shields.io/github/commit-activity/m/osapi-io/osapi?style=for-the-badge) -[![go reference](https://img.shields.io/badge/go-reference-00ADD8?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/osapi-io/osapi) +

+ + + + osapi + +

-# OS API +

A CRUD API for managing Linux systems.

- +

+ release + codecov + license + build + docker + cosign + sbom + powered by + conventional commits + openapi initiative + Linux + gitHub commit activity + go reference +

-*(OSAPI /ˈoʊsɑːpi/ - Oh-sah-pee)* A CRUD API for managing Linux systems. +

+Built for agents, there to empower humans. +

-This project provides basic management capabilities to Linux systems, enabling -them to be used as appliances. - -
- -OSAPI demo +

+Install one binary, point it at a config file, and get a REST API, a CLI, +a Go SDK and an embedded dashboard over a fleet of Linux hosts. Work reaches +a host by being queued rather than called, so a request becomes a job and an +agent runs it. +

## Documentation diff --git a/asset/logo-dark.svg b/asset/logo-dark.svg new file mode 100644 index 000000000..02da50c98 --- /dev/null +++ b/asset/logo-dark.svg @@ -0,0 +1,27 @@ + + osapi + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/asset/logo-light.svg b/asset/logo-light.svg new file mode 100644 index 000000000..d54ea8d33 --- /dev/null +++ b/asset/logo-light.svg @@ -0,0 +1,27 @@ + + osapi + + + + + + + + + + + + + + + + + + + + + + + + +