From d5f849f9f2fc286e4448110f2dff77fc8af1377e Mon Sep 17 00:00:00 2001 From: emrekasg Date: Mon, 22 Jan 2024 16:55:08 +0300 Subject: [PATCH] updated readme --- README.md | 27 ++++++++++++--------------- docs/index.html | 6 ++++-- docs/radar.css | 2 ++ 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1addd12..0746596 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Feel free to use and adapt it for your own purposes. ```html - + ``` 2. insert an empty `svg` tag: @@ -54,25 +54,12 @@ radar_visualization({ { name: "OUTER", color: "#f4c7c3" } ], print_layout: true, - entries: [ - { - label: "Some Entry", - quadrant: 3, // 0,1,2,3 (counting clockwise, starting from bottom right) - ring: 2, // 0,1,2,3 (starting from inside) - moved: -1 // -1 = moved out (triangle pointing down) - // 0 = not moved (circle) - // 1 = moved in (triangle pointing up) - }, + entries: // entries coming from config.json // ... ] }); ``` -Entries are positioned automatically so that they don't overlap. - -As a working example, you can check out `docs/index.html` — the source of our [public Tech -Radar](http://zalando.github.io/tech-radar/). - ## Local Development 1. install dependencies with yarn (or npm): @@ -93,6 +80,16 @@ yarn start http://localhost:3000/ ``` +## How did we deploy it? + +We use Cloudflare Pages to deploy our Tech Radar. It's an basic static site hosting service that is free with unlimited bandwidth. It automatically builds and deploys the site from the "master" branch of this repository whenever we push a change. There's no need to configure anything. + +Entries are positioned automatically so that they don't overlap. + +As a working example, you can check out `docs/index.html` — the source of our [public Tech +Radar](http://zalando.github.io/tech-radar/). + + ## License ``` diff --git a/docs/index.html b/docs/index.html index 846c9e9..3ba3aa1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,6 @@ -