add readme

README.md

@@ -0,0 +1,26 @@
+# Pulp UI CRI
+A OCI images for launching Pulp UI as container. Provides two images:
+- `base-frontend`: an empty image with only built frontend in `/www-root` dir. Can be used for example with Kubernetes as mounted image to container with any web server.
+- `nginx`
+
+For using with official Docker Compose and `pulp/pulp-web`, need make some changes in nginx config template. Add these sections:
+```nginx
+# At the moment when images is built, this is hardcoded in build config and cannot be overriden: in this directory Pulp UI expects compiled JS/CSS.
+# https://github.com/pulp/pulp-ui/blob/efc00f8071c5d7bef3a7b1cf06c91394b6c1e402/config/build.config.js
+location /static/pulp_ui/ {
+    proxy_pass http://ui/;
+}
+
+# The place where UI can be discovered: you may don't add this if you have plans distribute UI from `/static/pulp_ui/` too.
+location /ui/ {
+    proxy_pass http://ui/index.html?;
+}
+
+location /pulp-ui-config.json {
+    proxy_pass http://ui;
+}
+```
+
+## Configuring
+Pulp UI provides ability for small reconfiguring via modifying `/pulp-ui-config.json`. You may edit or mount own config. Build images uses default example (can be found in `pulp-ui` repository in root).
+