Initial readme

This commit is contained in:
Quentin 2025-02-20 20:24:04 +01:00
parent d95c3e2bb5
commit 70ae2c0808
Signed by: quentin
GPG key ID: E9602264D639FF68

41
README.md Normal file
View file

@ -0,0 +1,41 @@
# dxfl
A CLI tool to manage your Deuxfleurs account.
## Install
```
npm install -g git+https://git.deuxfleurs.fr/Deuxfleurs/dxfl
```
## Usage
*Not ready*
Start by login with your username, for example for `john`:
```
dxfl login john
```
Then you can list your websites:
```
dxfl list
```
And then to deploy your `_public` folder on `example.com`:
```
dxfl deploy example.com _public
```
## Development
```
git clone https://git.deuxfleurs.fr/Deuxfleurs/dxfl
cd dxfl
npm install
tsc
node index.js
```