Skip to content

Commit

Permalink
Fixed docs for renaming issues
Browse files Browse the repository at this point in the history
  • Loading branch information
chuacw committed Nov 5, 2024
1 parent a0101c4 commit 5e9462a
Show file tree
Hide file tree
Showing 591 changed files with 24,084 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
This package provides 3 providers for interacting with the Ronin blockchain.

The 3 Web3 providers are:
* SkyNet REST provider
* Skynet REST provider
* Ronin JSON RPC provider
* SkyNet Web3 provider
* Skynet Web3 provider

## SkyNet REST provider
A REST provider for SkyNet.
## Skynet REST provider
A REST provider for Skynet.

Use it like so:
```
const provider = createSkyNetRESTProvider(process.env["X-API-KEY"] || "");
const provider = createSkynetRESTProvider(process.env["X-API-KEY"] || "");
const contractAddr = "0xf6c5f9a72e6d46f30c7223a4cff854f94c7e95aa";
const response = await provider.get_contract_by_address(contractAddr);
```
Expand All @@ -30,10 +30,10 @@ Use this like so:
const provider = new RoninJsonRpcProvider(connection_info);
```

## Ronin SkyNet Web3 Provider
A SkyNet Web3 Provider for Ronin.
## Ronin Skynet Web3 Provider
A Skynet Web3 Provider for Ronin.

#### Creating an instance of the SkyNet Web3 Provider
#### Creating an instance of the Skynet Web3 Provider
---
Create it like this:

Expand All @@ -49,7 +49,7 @@ Create it like this:

or like this:
```
const provider = createSkyNetProvider(API_KEY);
const provider = createSkynetProvider(API_KEY);
```

Use it like so:
Expand All @@ -65,4 +65,4 @@ For further documentation, see the
* [HTML documents](https://chuacw.github.io/web3-ronin-provider/html/index.html).

## Examples
There's an [examples](./examples/) directory showing how to use the SkyNet Web3 provider.
There's an [examples](./examples/) directory showing how to use the Skynet Web3 provider.
1 change: 1 addition & 0 deletions docs/html/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
78 changes: 78 additions & 0 deletions docs/html/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
:root {
--light-hl-0: #000000;
--dark-hl-0: #D4D4D4;
--light-hl-1: #0000FF;
--dark-hl-1: #569CD6;
--light-hl-2: #0070C1;
--dark-hl-2: #4FC1FF;
--light-hl-3: #795E26;
--dark-hl-3: #DCDCAA;
--light-hl-4: #001080;
--dark-hl-4: #9CDCFE;
--light-hl-5: #A31515;
--dark-hl-5: #CE9178;
--light-hl-6: #AF00DB;
--dark-hl-6: #C586C0;
--light-hl-7: #098658;
--dark-hl-7: #B5CEA8;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}

@media (prefers-color-scheme: light) { :root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--code-background: var(--light-code-background);
} }

@media (prefers-color-scheme: dark) { :root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--code-background: var(--dark-code-background);
} }

:root[data-theme='light'] {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--code-background: var(--light-code-background);
}

:root[data-theme='dark'] {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--code-background: var(--dark-code-background);
}

.hl-0 { color: var(--hl-0); }
.hl-1 { color: var(--hl-1); }
.hl-2 { color: var(--hl-2); }
.hl-3 { color: var(--hl-3); }
.hl-4 { color: var(--hl-4); }
.hl-5 { color: var(--hl-5); }
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
pre, code { background: var(--code-background); }
18 changes: 18 additions & 0 deletions docs/html/assets/icons.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 5e9462a

Please sign in to comment.