Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
angrymouse committed Nov 8, 2023
1 parent 958f88b commit c7f24f6
Show file tree
Hide file tree
Showing 2 changed files with 212 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<center>

# Glomium

<img src="./glomium.svg" width="200" ></center>

Glomium is a powerful JavaScript module that serves as the core for [Glome](https://github.com/rareweave/glome), a smart contract engine optimized for creating performant, scalable, and secure smart contracts on Arweave.
By providing JavaScript bindings to the Duktape JS engine, Glomium enables the embedding and secure execution of JavaScript code within a Node.js environment (eval() but isolated), with custom resource constraints such as gas limits and memory costs.

Expand Down Expand Up @@ -80,7 +84,8 @@ Executes a string of JavaScript code within the Duktape execution context and re
- **Parameters**
- `code` _(string)_: The JavaScript code to execute.

## Building
## Building

You can build Glomium from source by executing following commands:

```bash
Expand All @@ -101,4 +106,4 @@ Contributions to Glomium are welcomed as it is a foundational component of the G

## License

Glomium is distributed under the MIT license.
Glomium is distributed under the MIT license.
205 changes: 205 additions & 0 deletions glomium.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c7f24f6

Please sign in to comment.