Skip to content

Commit b328b02

Browse files
committed
docs: init intro
1 parent 4a7ad83 commit b328b02

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

site/pages/index.md

+36-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1-
# ox – Ethereum Standard Library
1+
# Ox – Ethereum Standard Library
22

3-
TODO
3+
## Overview
4+
5+
Ox is the foundation of performant Ethereum software written in TypeScript. It is an **Ethereum Standard Library** that provides a set of lightweight, performant, and robust TypeScript modules for Ethereum.
6+
7+
It offers core utilities & types for primitives such as: ABIs, Addresses, Blocks, Bytes, ECDSA, Hex, JSON-RPC, RLP, Signatures, Transactions, and more.
8+
9+
As an unopinionated Standard Library, it is designed to be used by higher-level consumers (such as [Viem](https://viem.sh), [Tevm](https://tevm.sh), etc) to provide their own opinionated interfaces, and/or when reaching for low-level primitives may be needed without buying into a Client Abstraction stack (Viem, Ethers, Web3.js, etc).
10+
11+
## Installation
12+
13+
:::code-group
14+
15+
```bash [npm]
16+
npm i ox
17+
```
18+
19+
```bash [pnpm]
20+
pnpm i ox
21+
```
22+
23+
```bash [bun]
24+
bun i ox
25+
```
26+
27+
:::
28+
29+
## Example Usage
30+
31+
Below is an example of using the [`Hex`](#TODO) and [`Rlp`](#TODO) modules of Ox. Using [Namespace Imports](#TODO) can provide a better developer experience for readability and IDE autocompletion, without compromising on tree-shakability.
32+
33+
```ts twoslash
34+
import { Hex, Rlp } from 'ox'
35+
36+
const rlp = Rlp.encode([Hex.from('hello'), Hex.from('world')])
37+
```

0 commit comments

Comments
 (0)