diff --git a/README.md b/README.md index eb3f668c..244bf459 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -

MetaDock Contracts

+

Werk Contracts

- Smart contracts built for the MetaDock platform. + Smart contracts built for the Werk platform.

- - Tests + + Tests Built with Foundry - - Follow on X + + Follow on X Join Discord @@ -20,23 +20,23 @@

- - Logo + + Logo

-MetaDock aims to offer a decentralised platform for freelancers and small companies to run all their operations -leveraging the power of web3 as an organisation. +Werk aims to offer a decentralised platform for freelancers and small companies to run all their operations leveraging +the power of web3 as an organisation. ## Architecture Multiple Containers can be deployed, allowing ERC-20 and native tokens (ETH) to be deposited, acting as a user vault. At -the same time, a Container can execute arbitrary code on an unlimited number of Modules. This ability enhances the -MetaDock protocol with a modular architecture, providing an opportunity to create an open market of Modules where -external players can create and integrate their own use-cases into the protocol. +the same time, a Container can execute arbitrary code on an unlimited number of Modules. This ability enhances the Werk +protocol with a modular architecture, providing an opportunity to create an open market of Modules where external +players can create and integrate their own use-cases into the protocol. -A module must first be allowlisted through the `ModuleKeeper` before being made publicly available to MetaDock users. -Currently, due to the high-security risks, only the MetaDock team can add modules to or remove them from the allowlist. +A module must first be allowlisted through the `ModuleKeeper` before being made publicly available to Werk users. +Currently, due to the high-security risks, only the Werk team can add modules to or remove them from the allowlist. Once a module is allowlisted, it can be enabled via the `enableModule()` method available on any `Container`. @@ -54,7 +54,7 @@ creation and management. ## Contribute Anyone is welcomed to contribute either by creating & proposing a new module or simply -[opening](https://github.com/metadock/contracts/issues/new) an issue, starting a discussion or submitting a PR. +[opening](https://github.com/werk/contracts/issues/new) an issue, starting a discussion or submitting a PR. If you want to propose a new module, fork this repository and create a new folder inside the `src/modules/[module-name]` folder following the `src/modules/invoice-module` module structure. Then, create a new PR with the module logic and a @@ -62,5 +62,5 @@ detailed description of its capabilities. ## License -The primary license for MetaDock contracts is the GNU General Public License v3.0 (`GPL-3.0-or-later`), -see [LICENSE](https://github.com/metadock/contracts//blob/main/LICENSE). However, many files in `test/` are unlicensed. +The primary license for Werk contracts is the GNU General Public License v3.0 (`GPL-3.0-or-later`), +see [LICENSE](https://github.com/werk/contracts//blob/main/LICENSE). However, many files in `test/` are unlicensed. diff --git a/docs/images/metadock_banner.jpeg b/docs/images/metadock_banner.jpeg deleted file mode 100644 index 5455034c..00000000 Binary files a/docs/images/metadock_banner.jpeg and /dev/null differ diff --git a/docs/images/werk_banner.png b/docs/images/werk_banner.png new file mode 100644 index 00000000..4c7ac0b8 Binary files /dev/null and b/docs/images/werk_banner.png differ