Skip to content

Commit

Permalink
repo structure fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Arvolear committed Mar 27, 2024
1 parent 6800fa0 commit e6ca55d
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Bug Report
description: File a bug report
labels: ['bug']
assignees:
-
- arvolear
body:
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Feature request
description: Suggest a new feature
labels: ['feature']
assignees:
-
- arvolear
body:
- type: textarea
id: feature-description
Expand Down
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
Thank you for contributing to TokenF!
Please consider ticking the relevant statements.
-->

- [ ] Since this PR suggests a **bug fix**, the tests have been added and the coverage is 100%.
- [ ] Since this PR introduces a **new feature**, the update has been discussed in an Issue or with the team.
- [ ] This PR is just a **minor change**, like a typo fix.

---


<!-- Add the PR description here. -->
2 changes: 1 addition & 1 deletion .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ runs:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: "16.18.x"
node-version: "18.18.x"
cache: npm
- name: Install packages
run: npm install
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ Bring Real World Assets (RWA) on-chain via flexible tokenization framework - Tok

## Application

TokenF is an on-chain framework that enables development, management, and deployment of permissioned ERC20-compatible assets on EVM networks. TokenF enables custom rules to be configured for RWA tokens, providing flexible KYC/AML and regulatory compliance checks for the users to abide during interaction with the smart contracts.
TokenF is an on-chain framework that enables development, management, and deployment of permissioned ERC-20-compatible assets on EVM networks. TokenF enables custom rules to be configured for RWA tokens, providing flexible KYC/AML and regulatory compliance checks for the users to abide during interaction with the smart contracts.

TokenF is built with certain levels of abstraction in mind:

- ERC2535 Diamond beating heart that allows extensibility and upgradeability.
- ERC-2535 Diamond beating heart that allows extensibility and upgradeability.
- Support of custom compliance modules to be plugged in the TokenF core.
- Rich configuration of check/hooks/behavior with imagination being the only limit.

| **What TokenF Is ✅** | **What TokenF Is Not ❌** |
| :-----------------------------------------: | :------------------------------: |
| On-chain tokenization framework | Fullstack tokenization framework |
| Smart contracts to configure RWA behavior | RWA launchpad/RWA consulting set |
| Reimagined and enhanced ERC3643 alternative | Yet another ERC3643 copy |
| **What TokenF Is ✅** | **What TokenF Is Not ❌** |
| :-----------------------------------------: | :------------------------------: |
| On-chain tokenization framework | Fullstack tokenization framework |
| Smart contracts to configure RWA behavior | RWA launchpad/RWA consulting set |
| Reimagined and enhanced ERC-3643 alternative | Yet another ERC-3643 copy |

> [!NOTE]
> TokenF is at the early stage of development, many breaking changes are foreseen.
Expand Down

0 comments on commit e6ca55d

Please sign in to comment.