docs: Minor fixes to README after new website release

This commit is contained in:
Vincent Ambo 2019-08-05 01:20:52 +01:00 committed by Vincent Ambo
parent d87662b7b5
commit 12a853fab7

View file

@ -1,5 +1,5 @@
<div align="center"> <div align="center">
<img src="static/nixery-logo.png"> <img src="docs/src/nixery-logo.png">
</div> </div>
----------------- -----------------
@ -16,12 +16,13 @@ image name.
The path components refer to top-level keys in `nixpkgs` and are used to build a The path components refer to top-level keys in `nixpkgs` and are used to build a
container image using Nix's [buildLayeredImage][] functionality. container image using Nix's [buildLayeredImage][] functionality.
A public instance as well as additional documentation is available at
[nixery.dev][public].
The project started out with the intention of becoming a Kubernetes controller The project started out with the intention of becoming a Kubernetes controller
that can serve declarative image specifications specified in CRDs as container that can serve declarative image specifications specified in CRDs as container
images. The design for this is outlined in [a public gist][gist]. images. The design for this is outlined in [a public gist][gist].
An example instance is available at [nixery.dev][demo].
This is not an officially supported Google project. This is not an officially supported Google project.
## Usage example ## Usage example
@ -94,7 +95,7 @@ variables:
## Roadmap ## Roadmap
### Kubernetes integration (in the future) ### Kubernetes integration
It should be trivial to deploy Nixery inside of a Kubernetes cluster with It should be trivial to deploy Nixery inside of a Kubernetes cluster with
correct caching behaviour, addressing and so on. correct caching behaviour, addressing and so on.
@ -104,5 +105,5 @@ See [issue #4](https://github.com/google/nixery/issues/4).
[Nix]: https://nixos.org/ [Nix]: https://nixos.org/
[gist]: https://gist.github.com/tazjin/08f3d37073b3590aacac424303e6f745 [gist]: https://gist.github.com/tazjin/08f3d37073b3590aacac424303e6f745
[buildLayeredImage]: https://grahamc.com/blog/nix-and-layered-docker-images [buildLayeredImage]: https://grahamc.com/blog/nix-and-layered-docker-images
[demo]: https://nixery.dev [public]: https://nixery.dev
[gcs]: https://cloud.google.com/storage/ [gcs]: https://cloud.google.com/storage/