Skip to content

Commit

Permalink
more readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
monodot committed Jan 18, 2025
1 parent 5d8568f commit 9e21273
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<div style="text-align: center">
<div align="center">
<h1>💅 manikure</h1>
<p><strong>Interactive Editor for Kubernetes resources</strong></p>
<p><strong>Design and validate your Kubernetes configurations without writing YAML</strong></p>
<p><strong>Interactive editor for Kubernetes resources</strong></p>
<p><strong>Design and validate your Kubernetes configurations... <em>without having to remember all of that YAML!</em></strong></p>
</div>

<hr/>

<p style="text-align: center">
<p align="center">
<a href="https://manikure.netlify.app"><strong>👉 Try it out now: manikure.netlify.app 👈</strong></a>
</p>

<hr/>

<div style="text-align: center">
<div align="center">
<img alt="GitHub License" src="https://img.shields.io/github/license/monodot/manikure">
</div>

Expand All @@ -35,29 +35,37 @@
- [ ] Support for creating Helm charts
- [x] Make it look nicer (Now done using shadcn-vue!)

## Project setup
## Getting started

### Use in your browser

You can use Manikure in your browser without having to install it.

Simply head to https://manikure.netlify.app.

### Run locally

If you want to build and run this application locally, you'll need _npm_ installed:

```
```shell
# Install
npm install
```

Compile and hot-reload for development (starts a web server and enables hot-reload):

```
# Compile and hot-reload for development (starts a web server and enables hot-reload):
npm run dev
```

Compile and minify for production (builds the application into the `dist/` folder):
This will start a development server at `http://localhost:5173`.

If you want to create a production build of the application (builds the application's HTML, CSS and JS into the `dist/` folder):

```
npm run build
```

## Licence

(c) 2020-2024 Tom Donohue and authors. This is free software. It's provided to you under the terms of the [AGPL-3.0 License](LICENSE). You are free to copy, distribute or modify, but you must follow the terms of the licence.
(c) 2020-2025 Tom Donohue and authors. This is free software. It's provided to you under the terms of the [AGPL-3.0 License](LICENSE). You are free to copy, distribute or modify, but you must follow the terms of the licence.

### What does this licence mean?

Expand Down

0 comments on commit 9e21273

Please sign in to comment.