Skip to content

Commit 3f7bedc

Browse files
AndreiAndrei
authored andcommitted
fix: readme
1 parent a25ac11 commit 3f7bedc

File tree

1 file changed

+66
-6
lines changed

1 file changed

+66
-6
lines changed

README.md

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,75 @@
1-
# cli
1+
<p align="center">
2+
<img src="https://i.imgur.com/l3co8R0.png" alt="Codex Logo" width="300" height="300"/>
3+
</p>
24

3-
To install dependencies:
5+
# Invoice Generator CLI Tool
6+
7+
This tool was built to help developers quickly write up their invoices straight from the terminal. Why go about the hasle of writing a document yourself?
8+
9+
With automatic **PDF** conversion, this is the tool for your invoices!
10+
11+
## Installation
12+
13+
Firstly, install the CLI using brew
414

515
```bash
6-
bun install
16+
brew install invoice-cli
717
```
818

9-
To run:
19+
Simply run the `invoice-cli` command in your terminal, and configure your generator.
1020

1121
```bash
12-
bun run index.ts
22+
invoice-cli
1323
```
1424

15-
This project was created using `bun init` in bun v1.1.27. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
25+
## FAQ
26+
27+
#### Can I change the default template?
28+
29+
Yes, if you need to change the template of the invoice, then simply do so by running the `invoice-cli config` command, and drag and drop your HTML files in this directory. You need to make sure however that you specify elements with the [ids](https://google.com). This is so that the CLI tool can update these fields to produce the PDF file.
30+
31+
#### Can I access these in the browser?
32+
33+
Yes, simply run the `invoice-cli web` command, which will serve up a local build, where you can upload files, download, and view your recent invoice history.
34+
35+
36+
**NOTE**: If you want to run the generator tool without using any of the options specified in the config, run the command using the `--no-config` flag
37+
38+
```bash
39+
invoice-cli --no-config
40+
```
41+
42+
<!-- ## Debugging -->
43+
<!---->
44+
<!-- If you think you have found a bug within the generator, feel free to open an [issue](https://github.com/itzcodex24/invoice-cli/issues/new) against it. -->
45+
<!---->
46+
<!-- Use the `-debug` flag to show extra information when submitting an issue! -->
47+
<!---->
48+
<!-- ```bash -->
49+
<!-- invoice-cli -debug ..rest -->
50+
<!-- ``` -->
51+
52+
<!-- ## Features -->
53+
<!---->
54+
<!-- - Fully customizable -->
55+
<!-- - Infinite uses -->
56+
57+
## Feedback
58+
59+
If you have any feedback, please react out to me on my [portfolio website]('https://codex-dev.vercel.app')
60+
61+
<!-- ## Tech Stack -->
62+
<!---->
63+
<!-- TypeScript, Puppeteer -->
64+
<!---->
65+
## Contributing
66+
67+
Contributions are always welcome!
68+
69+
See `contributing.md` for ways to get started.
70+
71+
Please adhere to this project's `code of conduct`.
72+
73+
## License
74+
75+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)