Skip to content

Commit

Permalink
📝(client) add minimalist README
Browse files Browse the repository at this point in the history
For now, we want the full workflow to be operational.
  • Loading branch information
jmaupetit committed Jun 14, 2024
1 parent 2e8b483 commit 40a17de
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ Et enfin, pour lancer les tests du projet :
make test
```

## Utilisation du client d'API et du CLI `qcc`

Voir la documentation du projet : [./src/client/](./src/client/)

## Licence

QualiCharge est distribué selon les termes de la licence MIT (voir le fichier
Expand Down
10 changes: 10 additions & 0 deletions src/client/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MIT License

Copyright (c) 2024-present Ministères de la Transition écologique & de la Cohésion des territoires

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

18 changes: 18 additions & 0 deletions src/client/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# QualiCharge API client (and CLI!)

## Getting started with the CLI

`qcc` can be installed using `pip`:

```
pip install qcc
```

Get the list of commands and usage using the `--help` option:

```
qcc --help
```

## License

This work is released under the MIT License (see LICENSE).

0 comments on commit 40a17de

Please sign in to comment.