# vortex

**Repository Path**: kenneway/vortex

## Basic Information

- **Project Name**: vortex
- **Description**: No description available
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-23
- **Last Updated**: 2024-01-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# vortex

vortex is a simple tool to extract images from pdf files 

## Installation

### 1. Install Rust
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh 
````

### 2. Clone the repo
```
git clone https://github.com/omkar-mohanty/vortex.git && cd vortex
```
### 3. Install using cargo
```
cargo install --path .
```

## Usage

```bash
vortex pdf_file -o output_folder
```

### Example
From the crate root

```bash
vortex resources/sample.pdf -o sample 
```