-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: clean README and remove SDK_ACCESS_TOKEN
- Loading branch information
Showing
9 changed files
with
44 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,47 @@ | ||
# Welcome to Remix! | ||
|
||
- 📖 [Remix docs](https://remix.run/docs) | ||
## License | ||
|
||
This project is licensed under the **BSD 3-Clause License with Specific Usage Restrictions**. | ||
|
||
### Key Terms | ||
|
||
- **Permitted Use**: This software may only be used to develop applications (frontend or backend) that directly interface with the Merkl incentive distribution solution. | ||
- **Prohibited Uses**: | ||
- Developing standalone applications unrelated to the original backend. | ||
- Creating competitive backend services or applications. | ||
- Reverse engineering the core backend logic. | ||
- Developing alternative backend implementations. | ||
- **Commercial Use**: Commercial use of this software, including incorporating it into paid products or services, is **strictly prohibited without prior written approval** from Angle Labs, Inc. For inquiries regarding commercial use, contact [[email protected]]([email protected]) | ||
|
||
### Full License | ||
|
||
For detailed terms and conditions, refer to the [`LICENSE`](./LICENSE) file in this repository. | ||
|
||
|
||
# Welcome to Merkl Lite ! | ||
|
||
## Prerequisites | ||
- [Bun](https://bun.sh/) | ||
- [Remix](https://remix.run/docs) | ||
|
||
## Installation | ||
|
||
1. Go to `cd packages/dappkit` | ||
2. `git submodule init` | ||
3. `git submodule update` | ||
4. `bun i` | ||
5. `bun dev` | ||
5. `cd ../..` | ||
6. `bun i` | ||
7. `bun dev` | ||
|
||
## Development | ||
|
||
Run the dev server: | ||
|
||
```shellscript | ||
npm run dev | ||
``` | ||
|
||
## Updating a fork | ||
|
||
When pulling changes from `merkl-lite`, you have to: | ||
|
||
bun dev | ||
``` | ||
# (On the forked repository) | ||
# Fetch commits on merkl lite | ||
git fetch merkl-lite | ||
|
||
# Open a branch from main | ||
git checkout main | ||
git checkout -b sync | ||
# Merge changes from upstream | ||
git merge merkl-lite/main | ||
# Open a sync PR | ||
``` | ||
|
||
## Deployment | ||
|
||
|
@@ -67,20 +72,22 @@ Make sure to deploy the output of `npm run build` | |
|
||
This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever css framework you prefer. See the [Vite docs on css](https://vitejs.dev/guide/features.html#css) for more information. | ||
|
||
## License | ||
## Updating a fork | ||
|
||
This project is licensed under the **BSD 3-Clause License with Specific Usage Restrictions**. | ||
When pulling changes from `merkl-lite`, you have to: | ||
|
||
### Key Terms | ||
``` | ||
# (On the forked repository) | ||
- **Permitted Use**: This software may only be used to develop applications (frontend or backend) that directly interface with the Merkl incentive distribution solution. | ||
- **Prohibited Uses**: | ||
- Developing standalone applications unrelated to the original backend. | ||
- Creating competitive backend services or applications. | ||
- Reverse engineering the core backend logic. | ||
- Developing alternative backend implementations. | ||
- **Commercial Use**: Commercial use of this software, including incorporating it into paid products or services, is **strictly prohibited without prior written approval** from Angle Labs, Inc. For inquiries regarding commercial use, contact [[email protected]]([email protected]) | ||
# Fetch commits on merkl lite | ||
git fetch merkl-lite | ||
### Full License | ||
# Open a branch from main | ||
git checkout main | ||
git checkout -b sync | ||
For detailed terms and conditions, refer to the [`LICENSE`](./LICENSE) file in this repository. | ||
# Merge changes from upstream | ||
git merge merkl-lite/main | ||
# Open a sync PR | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule dappkit
updated
53 files