Skip to content

Commit

Permalink
fix: docs and command description (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pradumnasaraf committed Mar 13, 2023
1 parent 8abcbcc commit 57cdcd1
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
11 changes: 7 additions & 4 deletions README.md
Expand Up @@ -4,6 +4,8 @@

![Candy CLI logo](https://user-images.githubusercontent.com/51878265/224826395-f62efa65-f64c-4c2e-aa93-ad6f72e0d5d7.png)

[![Releases](https://github.com/Pradumnasaraf/candy/actions/workflows/releases.yml/badge.svg)](https://github.com/Pradumnasaraf/candy/actions/workflows/releases.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/Pradumnasaraf/candy.svg)](https://pkg.go.dev/github.com/Pradumnasaraf/candy)

</div>

**Candy** 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 build with [Go](https://github.com/golang/go), [Cobra](https://github.com/spf13/cobra), [Viper](https://github.com/spf13/viper), etc
Expand All @@ -23,18 +25,19 @@ Once installed, you can use the `candy` CLI command. To confirm installation, ty

```
Usage:
candy [flags]
candy [command]
Available Commands:
JTY Converts a JSON file to YAML
YTJ Converts a YAML file to JSON
JTY Converts a JSON into YAML and output the result in output.yaml file
YTJ Converts a YAML into JSON and output the result in output.json file
help Help about any command
```

Eg `candy JTY --file test.json` with convert JSON into YAML and create a `output.yaml` in you currect directory.

## 📜 License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details
This project is licensed under the Apache-2.0 license - see the [LICENSE](LICENSE) file for details

## 🛡 Security

Expand Down
2 changes: 1 addition & 1 deletion cmd/JsonToYaml.go
Expand Up @@ -15,7 +15,7 @@ var (
// yamlToJsonCmd represents the yamlToJson command
var JsonToYaml = &cobra.Command{
Use: "JTY",
Short: "Converts a JSON file to YAML",
Short: "Converts a JSON into YAML and output the result in output.yaml file",
Run: func(cmd *cobra.Command, args []string) {

// Read the JSON file
Expand Down
2 changes: 1 addition & 1 deletion cmd/yamlToJson copy.go
Expand Up @@ -15,7 +15,7 @@ var (
// yamlToJsonCmd represents the yamlToJson command
var yamlToJsonCmd = &cobra.Command{
Use: "YTJ",
Short: "Converts a YAML file to JSON",
Short: "Converts a YAML into JSON and output the result in output.json file",
Run: func(cmd *cobra.Command, args []string) {

// Read the YAML file
Expand Down
4 changes: 2 additions & 2 deletions releases.json
@@ -1,3 +1,3 @@
{
"version": "0.1.0"
}
"version": "1.0.0"
}

0 comments on commit 57cdcd1

Please sign in to comment.