From 5880e88f9d3be03ec537b3e93a6b02528551bbe1 Mon Sep 17 00:00:00 2001
From: Sylvain Gougouzian <sylvain.gougouzian@gmail.com>
Date: Thu, 18 Apr 2024 08:36:41 +0200
Subject: [PATCH] docs: :memo: add readme

---
 README.md | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index f047d30..0125d95 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,21 @@
-# conferencehall-orga-classment
+# CHOC
 
-To install dependencies:
+ConferenceHall organization companion
 
-```bash
-bun install
 ```
+Usage: choc [options] <json>
 
-To run:
+ConferenceHall organization companion
 
-```bash
-bun run index.ts
-```
+Arguments:
+  json                     the json export file
 
-This project was created using `bun init` in bun v1.1.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+Options:
+  -v, --version            output the version number
+  -c, --with-categories    view categories (default: false)
+  -f, --with-formats       view formats (default: false)
+  -e, --with-companies     view speakers company (default: false)
+  -l, --with-languages     view talks language (default: false)
+  -t, --titlelength <int>  the title length (default: 100)
+  -h, --help               display help for command
+```