Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ltfschoen committed Oct 16, 2024
1 parent 2de17de commit 75ad81d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
12 changes: 4 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# Welcome to Scaffold-ETH 2 Contributing Guide
# Welcome to Nunya.business Contributing Guide

Thank you for investing your time in contributing to Scaffold-ETH 2!
Thank you for investing your time in contributing to Nunya.business!

This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

## About the Project

Scaffold-ETH 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.
Nunya.business is a minimal and forkable repo for builders.

Read the [README](README.md) to get an overview of the project.

### Vision

The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.

The repo can be forked to include integrations and more features, but we want to keep the master branch simple and minimal.

### Project Status
Expand Down Expand Up @@ -44,7 +40,7 @@ Issues should be used to report problems, request a new feature, or discuss pote

#### Solve an issue

Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.
Scan through our [existing issues](https://github.com/svub/nunya/issues) to find one that interests you.

If a contributor is working on the issue, they will be assigned to the individual. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix for it.

Expand Down
6 changes: 3 additions & 3 deletions _DEMO_AND_VIDEO.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Demo and Video

TODO - Create a demo or video showcasing your project's functionality. Videos are particularly helpful in conveying the project's value and can be easily shared and understood by judges and the public. Preferably contracts have a usable UI/Mockup to be shown.
> Below are demos and videos showcasing our project's functionality. Videos are particularly helpful in conveying the project's value and can be easily shared and understood by judges and the public. Preferably contracts have a usable UI/Mockup to be shown.
## Demos
## Screenshots

* Screenshots:

Expand All @@ -14,7 +14,7 @@ TODO - Create a demo or video showcasing your project's functionality. Videos ar

![Screenshot](./assets/screenshot-deploy-gateway.png)

* Videos:
## Videos

* Video of Nunya.business compile, upload, and instantiate a Private Secret Contract to Secret Network Testnet
[YouTube Link](https://youtu.be/pCtQjqqD6gs)
Expand Down
4 changes: 3 additions & 1 deletion _SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,6 @@ The deployed [Nunya Private Contract](./packages/secret-contracts/nunya-contract

### Usage Guidelines <a id="usage"></a>

TODO - help judges and other developers understand the project.
Help judges and other developers understand the project.

See the [DEMO_AND_VIDEO](./_DEMO_AND_VIDEO.md) file for details.

0 comments on commit 75ad81d

Please sign in to comment.