Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego committed Oct 13, 2023
1 parent 44713ff commit 18d5d07
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Polars CLI

![Crates.io](https://img.shields.io/crates/v/polars-cli)
![PyPI - Version](https://img.shields.io/pypi/v/polars-cli)

The Polars command line interface provides a way to easily execute SQL commands using Polars as a backend.

## Installation

Until binaries are available, the only way to install the Polars CLI is by building it from source:

```bash
cargo +nightly install --locked polars-cli
```

Alternatively, clone the repository and install the latest version on the main branch:
Until binaries are available, the only way to install the Polars CLI is by building it from source:

```bash
cargo install --locked --path .
cargo install --locked polars-cli
```

#### Prerequisites

1. `rustup`: which provides the `cargo` executable. You can get it from the [official website](https://rustup.rs/).
2. `rustup install nightly` - The `nightly` version of rust, since some of our dependencies use unstable features.

## Usage

```shell
$ polars
Polars CLI version 0.3.0
Polars CLI version 0.4.0
Type .help for help.

>> select * FROM read_csv('examples/datasets/foods1.csv');
>> select * FROM read_csv('examples/datasets/foods.csv');
┌────────────┬──────────┬────────┬──────────┐
│ category ┆ calories ┆ fats_g ┆ sugars_g │
│ --- ┆ --- ┆ --- ┆ --- │
Expand Down

0 comments on commit 18d5d07

Please sign in to comment.