diff --git a/README.md b/README.md index 92b23f5..9e732fa 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ ![rabbitory logo](https://raw.githubusercontent.com/your-username/rabbitory/main/assets/rabbitory-logo.png) -[![npm version](https://img.shields.io/npm/v/rabbitory)](https://www.npmjs.com/package/rabbitory) -~add real npm package here~ +[![npm version](https://img.shields.io/npm/v/rabbitory_cli)](https://www.npmjs.com/package/rabbitory_cli) # Rabbitory CLI +**Rabbitory CLI** is a command-line interface tool designed to streamline the deployment of the Rabbitory Control Panel infrastructure on AWS. With Rabbitory CLI, you can effortlessly integrate with your AWS environment and automatically provision the resources needed to manage your RabbitMQ instances on the Cloud. + - [Rabbitory CLI](#rabbitory-cli) - [🛠 Features](#🛠-features) - [Seamless AWS Integration](#seamless-aws-integration) @@ -16,11 +17,9 @@ - [Installing Rabbitory CLI](#installing-rabbitory-cli) - [🐰 Usage](#🐰-usage) - [Deploying Rabbitory](#deploying-rabbitory) - - [Custom Domain Setup](#custom-domain-setup) + - [Custom Domain Setup](#custom-domain-setup) - [Tearing down Rabbitory](#tearing-down-rabbitory) -**Rabbitory CLI** is a command-line interface tool designed to streamline the deployment of the Rabbitory Control Panel infrastructure on AWS. With Rabbitory CLI, you can effortlessly integrate with your AWS environment and automatically provision the resources needed to manage your RabbitMQ instances on the Cloud. - ## 🛠 Features ### Seamless AWS Integration @@ -60,7 +59,8 @@ Before installing Rabbitory, ensure that you have the following installed: Once your AWS credentials are set up, you can install the Rabbitory CLI by running the following command: ``` -npm install -g rabbitory +npm install rabbitory_cli -g + ``` --- diff --git a/assets/rabbitory-logo.png b/assets/rabbitory-logo.png new file mode 100644 index 0000000..623135e Binary files /dev/null and b/assets/rabbitory-logo.png differ diff --git a/package.json b/package.json index 3bd2d9d..0f16016 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,11 @@ { "name": "rabbitory_cli", - "version": "1.0.0", - "description": "Command Line Interface for Rabbitory", + "version": "0.1.0", + "description": "Rabbitory's custom Command Line Interface for provisioning and managing self-hosted RabbitMQ instances on AWS EC2", + "repository": { + "type": "git", + "url": "https://github.com/Rabbitory/rabbitory_cli" + }, "bin": { "rabbitory": "./dist/cli/cli.js" }, @@ -10,7 +14,21 @@ "lint": "eslint", "test": "jest" }, - "keywords": [], + "keywords": [ "rabbitmq", + "cli", + "aws", + "ec2", + "rabbitory", + "message-broker", + "infrastructure", + "devops", + "self-hosted", + "cloud", + "automation", + "deployment", + "provisioning", + "messaging", + "amqp"], "author": "", "license": "ISC", "dependencies": {