From bb3874a448ad6b863eb1e832a6b2bd0a8047fd84 Mon Sep 17 00:00:00 2001 From: Ajay Sreedhar Date: Wed, 1 Nov 2023 22:24:04 +0530 Subject: [PATCH] change: Sync README with code repo --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0842d66..b2c92b4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@
- Primate Logo + Primate Logo

Primate (formerly KongDash) is a desktop client for Kong Admin API

getprimate.xyz

-

Primate Screenshot

+

Primate Screenshot

--- +## Version Compatibility + +| Primate version | Kong Admin API versions | +|-----------------|-------------------------| +| 1.0.0 - 1.1.0 | `2.7.x` `2.8.x` | + ## :package: Download and Install Builds are available for major desktop operating systems. @@ -14,8 +20,8 @@ Builds are available for major desktop operating systems. #### On Windows Download the [latest](https://github.com/getprimate/primate/releases/latest) executable setup file and run it. -#### On Mac OS X -Download and open the [latest](https://github.com/getprimate/primate/releases/latest) .dmg image, move the app to /Applications. +#### On macOS +Download and open the [latest](https://github.com/getprimate/primate/releases/latest) DMG file, move the app to /Applications. #### On Linux Primate is available as AppImage and tar.gz archive for all popular Linux distributions. @@ -38,6 +44,8 @@ There are several ways to support development: - Provide feedbacks and suggest improvements. - Contribute to the development with pull requests. +For a complete overview, see the [contributing](CONTRIBUTING.md) guide. + ### For Developers - Requires NodeJs (v16.13.2 or higher) and yarn (v1.22.17 or higher). @@ -69,4 +77,14 @@ Run `$ yarn run clean` to clean the output directories. _Currently, compiling to non-native binary is disabled._ ## :spiral_notepad: License -MIT License. See [LICENSE](https://github.com/getprimate/primate/blob/main/LICENSE). \ No newline at end of file +MIT License. See [LICENSE](LICENSE). + +## :raised_hands: Supporters + + + JetBrains Black Box Logo logo. + +    + + +