diff --git a/README.md b/README.md index 656e335..496b210 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ -[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](LICENSE) -[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org) -[![docs driven](https://img.shields.io/badge/docs-driven-blue.svg?style=for-the-badge)](CONTRIBUTING.md) -![gitHub commit activity](https://img.shields.io/github/commit-activity/m/osapi-io/specs?style=for-the-badge) - -# specs - -The design docs for [osapi-io]. How each repository is built and why, in one -place, kept current as they change. No product code here. +

+ + + + specs + +

+ +

The design docs for osapi-io. Written before the code, corrected when the code proves them wrong.

+ +

+ license + conventional commits + docs driven + built with just + github commit activity +

+ +

+Doc-driven: the page is the design, then the description. +

+ +

+You design something by writing its page, build it, then correct the page where +building proved it wrong. Same page all three times, so nothing is converted from +one form into another, because that conversion is where the design and the docs +drift apart. +

## Usage diff --git a/asset/logo-dark.svg b/asset/logo-dark.svg new file mode 100644 index 0000000..d688a89 --- /dev/null +++ b/asset/logo-dark.svg @@ -0,0 +1,29 @@ + + specs + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/asset/logo-light.svg b/asset/logo-light.svg new file mode 100644 index 0000000..375e75d --- /dev/null +++ b/asset/logo-light.svg @@ -0,0 +1,29 @@ + + specs + + + + + + + + + + + + + + + + + + + + + + + + + + +