Skip to content

Commit

Permalink
chore: add installation instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iankressin committed Jul 4, 2024
1 parent 57ab875 commit 822cebe
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

This query language allows users to interact with EVM chain data and perform various operations on entities like accounts, blocks, and transactions. Below is a summary of the entities and expressions available in this language:

## Installation
To begin, install eqlup, the EQL version manager, by running the following command:
```bash
curl https://raw.githubusercontent.com/iankressin/eql/main/eqlup/install.sh | sh
````

Next, install the latest version of EQL using this command:
```bash
eqlup
```

### Updating EQL
To update EQL to the latest version, you can simply run `eqlup` again:
```bash
eqlup
```

## Entities:
### Account:
- address [id]
Expand Down Expand Up @@ -34,16 +51,14 @@ This query language allows users to interact with EVM chain data and perform var

*Example*: `GET nonce, balance FROM account vitalik.eth ON base`

### SEND:
### SEND (Soon):
*Description*: Sends a transaction to the network

*Production*: `SEND <type> to=<address>, value=<ether>, data=<bytes> ON <chain>`

*Example*: `SEND TX to=vitalik.eth, value=1, data=0x0...000 ON arbitrum`

`SEND TOKEN token=0x00...000, to=vitalik.eth amount=0.001 ON ethereum`

### MATH:
### MATH (Soon):
*Description*: Supports basic math operations like SUM, SUB, DIV, TIMES

*Production*: `<operator>(<[expr, ]>)`
Expand Down

0 comments on commit 822cebe

Please sign in to comment.