Initial readme
This commit is contained in:
parent
d95c3e2bb5
commit
70ae2c0808
1 changed files with 41 additions and 0 deletions
41
README.md
Normal file
41
README.md
Normal 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
|
||||
```
|
Loading…
Add table
Reference in a new issue