Skip to content

Commit

Permalink
docs() Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
immortal-tofu committed Jun 21, 2023
1 parent a44d00c commit 509545a
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Main

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm test
- run: npm run build
5 changes: 3 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: Node.js CI
name: PR test

on:
pull_request:

branches:
- main
jobs:
build:
runs-on: ubuntu-latest
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# fhevmjs

This is a library to interact with a blockchain using fhEVM.
![Main](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)

fhevmjs is a javascript library that enables developers to interact with blockchains using Zama's cutting-edge technology based on TFHE (Fully Homomorphic Encryption over the Torus). This library provides a seamless integration of TFHE encryption capabilities into web3 applications, allowing for secure and private interactions with smart contracts.

## Installation

```bash
# Using npm
npm install fhevmjs

# Using Yarn
yarn add fhevmjs
```

This will download and install the fhevmjs library and its dependencies into your project.

## Documentation

Soon...

0 comments on commit 509545a

Please sign in to comment.