Skip to content

Commit

Permalink
docs: 📝 add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gouz committed Apr 18, 2024
1 parent 3ac3511 commit 5880e88
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 5880e88

Please sign in to comment.