From 87d2e91ad2408f3fde5786e59a4fc7c5e48884af Mon Sep 17 00:00:00 2001
From: Adrien Siami <adrien@siami.fr>
Date: Wed, 4 Sep 2024 19:26:56 +0200
Subject: [PATCH] Create README

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index feb574f..ba1d0f4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
-# Yamlfish
+# YAMLFish CLI
+
+This is the command line interface for [YAMLFish](https:s://yamlfish.dev), the simple and powerful translation management platform.
+
+## Installation
+
+The YAMLFish CLI is available as a Ruby gem.
+First, make sure you have Ruby installed on your machine. You can follow the [official Ruby installation guide](https://www.ruby-lang.org/en/documentation/installation/) for your operating system.
+
+Then, to install the YAMLFish CLI, run:
+
+```bash
+gem install yamlfish-cli --pre
+```
+
+YAMLFish is still in beta, hence the `--pre` flag to install the latest RC.
+
+## Configuration
+
+Before you can use the YAMLFish CLI, you need to configure it with your API key and project token.
+
+To do this, create a `.yamlfish.yml` file in your project's root directory with the following content:
+
+```yaml
+api_key: YOUR_API_KEY
+project_token: YOUR_PROJECT_TOKEN
+```
+
+Those secrets can be found in the footer of your project's page on YAMLFish.
+
+## Usage
+
+For usage instructions, please refer to the [official documentation](https://yamlfish.dev/docs/).