Skip to content

Commit

Permalink
Merge pull request #9 from RakshitKumar04/link-patch1
Browse files Browse the repository at this point in the history
Updated README.md: Verify and Add New Links
  • Loading branch information
AryanSharma9917 authored Jun 16, 2024
2 parents d1fa200 + 149c07b commit c397159
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

**Codewise** is a CLI tool that provides a basic set of commands to perform tedious tasks such as converting **YAML to JSON** or **JSON to YAML** directly from your terminal. It's built with [Go](https://github.com/golang/go), [Cobra](https://github.com/spf13/cobra), [Viper](https://github.com/spf13/viper), etc.

To install the Codewise-CLI, use the command `go install github.com/AryanSharma9917/Codewise-CLI@latest`.
To install the Codewise-CLI, use the command `go install github.com/aryansharma9917/Codewise-CLI@latest`.
Go will automatically install it in your `$GOPATH/bin` directory, which should be in your `$PATH`.

Once installed, you can use the `Codewise-CLI` CLI command. To confirm installation, type `Codewise-CLI` at the command line.
Expand All @@ -18,7 +18,7 @@ Once installed, you can use the `Codewise-CLI` CLI command. To confirm installat
## 📚 Documentation

**Check out detailed documentation for getting started and using Codewise CLI** [**here**](https://pkg.go.dev/github.com/aryansharma9917/Codewise-CLI).
**Check out detailed documentation for getting started and using Codewise CLI** [**here**](https://gist.github.com/AryanSharma9917/a93356bb49a7269826976d7f8d89f11a).

## ⭐️ Features

Expand All @@ -34,8 +34,8 @@ Once installed, you can use the `Codewise-CLI` CLI command. To confirm installat

```
Usage:
codewise-cli [command] [flags]
codewise-cli [command]
Codewise-CLI [command] [flags]
Codewise-CLI [command]
Available Commands:
JTY Converts a JSON into YAML.
Expand All @@ -46,13 +46,13 @@ Available Commands:
k8s Kubernetes related commands. Like generating manifest files for kubernetes objects.
```

For detailed usage of each command, visit [here](https://pkg.go.dev/github.com/aryansharma9917/Codewise-CLI)
For detailed usage of each command, visit [here](https://docs-two-eosin.vercel.app/#/)

Eg `codewise-cli JTY --file test.json` with convert JSON into YAML and create a `output.yaml` in your current directory.
Eg `Codewise-CLI JTY --file test.json` with convert JSON into YAML and create a `output.yaml` in your current directory.

Eg `codewise-cli docker dockerfile --lang go` to generate a `Dockerfile` template for go.
Eg `Codewise-CLI docker dockerfile --lang go` to generate a `Dockerfile` template for go.

eg `codewise-cli k8s manifest --obj deployment` to generate a `deployment.yaml` file with deployment template.
eg `Codewise-CLI k8s manifest --obj deployment` to generate a `deployment.yaml` file with deployment template.

## 📜 License

Expand Down

0 comments on commit c397159

Please sign in to comment.