Skip to content

Commit 08a45f5

Browse files
committed
feat(#ci): - Fuego-05 - Improve README and CI
1 parent 38cda52 commit 08a45f5

File tree

2 files changed

+87
-1
lines changed

2 files changed

+87
-1
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Features
1+
name: Main
22

33
on:
44
push:

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,90 @@
1+
[![Github Actions Status](https://github.com/Prims47/FuegoBilling/workflows/Main/badge.svg)](https://github.com/Prims47/FuegoBilling/actions)
12
[![GoReportCard](https://goreportcard.com/badge/github.com/Prims47/FuegoBilling)](https://goreportcard.com/report/github.com/Prims47/FuegoBilling)
23
[![codecov](https://codecov.io/gh/prims47/FuegoBilling/branch/main/graph/badge.svg)](https://codecov.io/gh/prims47/FuegoBilling)
34

45
# FuegoBilling
6+
7+
8+
9+
## Usage
10+
11+
### Download binary
12+
13+
You can download the latest version of the binary built for your architecture here:
14+
15+
* Architecture **i386** [
16+
[Darwin](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-darwin-386) /
17+
[Linux](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-linux-386)
18+
]
19+
* Architecture **amd64** [
20+
[Darwin](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-darwin-amd64) /
21+
[Linux](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-linux-amd64) /
22+
[Windows](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-windows-amd64.exe)
23+
]
24+
* Architecture **arm** [
25+
[Linux](https://github.com/Prims47/FuegoBilling/releases/latest/download/fuegoBilling-linux-arm)
26+
]
27+
28+
### Create your configuration files
29+
30+
You must create your `json` configurations files like (all fields are required):
31+
32+
```json
33+
// your-personal-account.json
34+
{
35+
"address": {
36+
"city": "Paris",
37+
"street": "770 rue Pepito",
38+
"country": "France",
39+
"zipCode": "75006"
40+
},
41+
"company": {
42+
"siret": "88462068300018",
43+
"tva": "FR77049322770",
44+
"capital": 100.00,
45+
"rcs": "Nanterre B",
46+
"naf": "6201Z",
47+
"type": "SARL"
48+
},
49+
"name": "Fuego by P",
50+
"firstname": "Ilan",
51+
"lastname": "Zerath",
52+
53+
}
54+
```
55+
56+
```json
57+
// your-customer.json
58+
{
59+
"address": {
60+
"city": "Paris",
61+
"street": "47 rue Fuego",
62+
"country": "France",
63+
"zipCode": "75017"
64+
},
65+
"company": {
66+
"siret": "88462068300018",
67+
"tva": "FR77049322770",
68+
"type": "SARL"
69+
},
70+
"name": "Space X"
71+
}
72+
```
73+
74+
```json
75+
// your-service.json
76+
{
77+
"tva": {
78+
"pourcent": 20
79+
},
80+
"detail": "Prestation Pepito Fuego by P",
81+
"quantity": 7.5,
82+
"unitPrice": 863
83+
}
84+
```
85+
86+
### Create your billing
87+
88+
```shell
89+
$ fuegoBilling generate-pdf --account-config-path your-personal-account.json --customer-config-path your-customer.json --service-config-path your-service.json --pdf-path your-pdf-path
90+
```

0 commit comments

Comments
 (0)