Skip to content

Commit

Permalink
docs: ✏️ Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asd153866714 committed Jun 8, 2023
1 parent 667d81c commit 0ce6f20
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# cli-dance
Command line animations

Cli-dance is a command-line tool that provides a collection of frames which can be used to create animations.

## installation

```shell
git clone https://github.com/asd153866714/cli-dance.git
cd cli-danc
epython main.py
```

## Usage

```
$ python main.py --help
usage: main.py [-h] [-l] [-f FRAMES]
Simple program with command-line arguments
optional arguments:
-h, --help show this help message and exit
-l, --list Show the list of frames
-f FRAMES, --frames FRAMES
Display frames
```

## License

This project is licensed under the [MIT License](link-to-your-license-file).

0 comments on commit 0ce6f20

Please sign in to comment.