From 822cebe4eb1c5e7fa97f73e98b7d757461cc6c2f Mon Sep 17 00:00:00 2001 From: Ian Guimaraes Date: Thu, 4 Jul 2024 18:40:13 -0300 Subject: [PATCH] chore: add installation instructions to readme --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 397c180..31586b4 100644 --- a/README.md +++ b/README.md @@ -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] @@ -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 to=
, value=, data= ON ` *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*: `(<[expr, ]>)`