Skip to content

Commit 2b82079

Browse files
committed
README: Add sol description
1 parent c799b2c commit 2b82079

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,17 @@ site.
55

66
## `gh-pages` organization
77

8-
- `js`: holds JavaScript and TypeScript packages named after the package name
9-
deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For example
10-
`@oasisprotocol/client` is hosted inside `js/client` path.
11-
- `rust`: holds Rust packages named after the import name of the package e.g.
12-
`oasis_runtime_sdk`.
8+
- `js`: contains API reference for JavaScript and TypeScript packages named
9+
after the package name deployed at npmjs.org, but with stripped
10+
`@oasisprotocol/` prefix. For example `@oasisprotocol/client` is hosted
11+
inside `js/client` folder.
12+
- `sol`: contains API reference for Solidity packages named after the package
13+
name deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For
14+
example `@oasisprotocol/sapphire-contracts` is hosted inside
15+
`sol/sapphire-contracts`.
16+
- `rust`: contains API reference for Rust packages named after the import name
17+
of the package e.g. `oasis_runtime_sdk`.
1318

14-
The branch is periodically updated by fetching the content of `api-reference`
15-
branch of the `oasis-sdk`, `sapphire-paratime` and other relevant Oasis
16-
repositories.
19+
`gh-pages` branch is periodically updated by fetching the content of
20+
`api-reference` branch of the `oasis-sdk`, `sapphire-paratime` and other Oasis
21+
repositories in the future.

0 commit comments

Comments
 (0)