Skip to content

Commit 822cebe

Browse files
committed
chore: add installation instructions to readme
1 parent 57ab875 commit 822cebe

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
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:
44

5+
## Installation
6+
To begin, install eqlup, the EQL version manager, by running the following command:
7+
```bash
8+
curl https://raw.githubusercontent.com/iankressin/eql/main/eqlup/install.sh | sh
9+
````
10+
11+
Next, install the latest version of EQL using this command:
12+
```bash
13+
eqlup
14+
```
15+
16+
### Updating EQL
17+
To update EQL to the latest version, you can simply run `eqlup` again:
18+
```bash
19+
eqlup
20+
```
21+
522
## Entities:
623
### Account:
724
- address [id]
@@ -34,16 +51,14 @@ This query language allows users to interact with EVM chain data and perform var
3451

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

37-
### SEND:
54+
### SEND (Soon):
3855
*Description*: Sends a transaction to the network
3956

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

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

44-
`SEND TOKEN token=0x00...000, to=vitalik.eth amount=0.001 ON ethereum`
45-
46-
### MATH:
61+
### MATH (Soon):
4762
*Description*: Supports basic math operations like SUM, SUB, DIV, TIMES
4863

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

0 commit comments

Comments
 (0)