Skip to content

Commit 8eace3a

Browse files
committed
Update Docs: Add installation setup
1 parent 4c26dae commit 8eace3a

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

README.md

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="./logo.svg" alt="Filto" width="200"/>
33
<h1>Filto</h1>
44
<p>
5-
<strong>Fast, lightweight, and privacy-focused CLI tool for file conversion</strong>
5+
<strong>Fast, lightweight, and privacy-focused CLI tool for file conversion</strong>
66
</p>
77
<p>
88
<a href="#features">Features</a> •
@@ -29,36 +29,59 @@
2929

3030
### Supported Conversions
3131

32-
- **Images** → PDF
32+
#### Currently Available
33+
- **Images** → PDF (supports PNG, JPG)
3334
- **PDF** → Word (DOCX)
3435
- **PDF** → PowerPoint (PPTX)
35-
- **PDF** → Images
36-
- **PowerPoint** → PDF
37-
- **Excel** → PDF
38-
- **HTML** → PDF
39-
- **Merge** multiple PDFs into one
40-
- **Split** PDFs into specific page ranges
41-
- **Compress** PDFs to smaller sizes
42-
- **Extract** text or images from PDFs
43-
- **Convert** between various document formats
36+
- **PDF** → Images (JPG)
4437

45-
## Installation
38+
#### Coming Soon
39+
- PowerPoint → PDF
40+
- Excel → PDF
41+
- HTML → PDF
42+
- Merge multiple PDFs
43+
- PDF compression
44+
- PDF text extraction
4645

46+
## Installation
47+
### Quick Install
48+
Install Filto using npm:
4749

48-
### Quick Install
4950
```bash
51+
npm install filto
52+
```
5053

54+
### Verify Installation
55+
```bash
56+
filto --version
5157
```
5258

5359
### From Source
60+
1. Clone the repository:
61+
```bash
62+
git clone https://github.com/OsamaRab3/filto.git
63+
cd filto
64+
```
65+
66+
2. Install dependencies:
67+
```bash
68+
npm install
69+
```
70+
71+
3. Build the project:
5472
```bash
73+
npm run build
74+
```
5575

76+
4. Link it globally:
77+
```bash
78+
npm link
5679
```
5780

58-
## Usage
81+
## Usage
5982

6083
```
61-
filto [OPTIONS] COMMAND [ARGS]...
84+
filto convert <input> <output>
6285
```
6386

6487
## Basic Commands

0 commit comments

Comments
 (0)