Skip to content

Commit caff959

Browse files
Update README.md
1 parent 518c70a commit caff959

1 file changed

Lines changed: 3 additions & 104 deletions

File tree

README.md

Lines changed: 3 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<!-- Organization Logo -->
55
<div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;">
66
<img alt="Stability Nexus" src="public/stability.svg" width="175">
7-
<img src="public/todo-project-logo.svg" width="175" />
7+
<!--<img src="public/todo-project-logo.svg" width="175" /> -->
88
</div>
99

1010
&nbsp;
1111

1212
<!-- Organization Name -->
1313
<div align="center">
1414

15-
[![Static Badge](https://img.shields.io/badge/Stability_Nexus-/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.stability.nexus/)
15+
[![Static Badge](https://img.shields.io/badge/Stability_Nexus-MiniChain-228B22?style=for-the-badge&labelColor=FFC517)](https://stability.nexus/)
1616

1717
<!-- Correct deployed url to be added -->
1818

@@ -101,65 +101,12 @@ It is encouraged that you develop an initial prototype during the application ph
101101
* Read this book: https://www.marabu.dev/blockchain-foundations.pdf
102102

103103

104-
---
105-
106-
## Project Maturity
107-
108-
TODO: In the checklist below, mark the items that have been completed and delete items that are not applicable to the current project:
109-
110-
* [ ] The project has a logo.
111-
* [ ] The project has a favicon.
112-
* [ ] The protocol:
113-
- [ ] has been described and formally specified in a paper.
114-
- [ ] has had its main properties mathematically proven.
115-
- [ ] has been formally verified.
116-
* [ ] The smart contracts:
117-
- [ ] were thoroughly reviewed by at least two knights of The Stable Order.
118-
- [ ] were deployed to:
119-
- [ ] Ergo
120-
- [ ] Cardano
121-
- [ ] EVM Chains:
122-
- [ ] Ethereum Classic
123-
- [ ] Ethereum
124-
- [ ] Polygon
125-
- [ ] BSC
126-
- [ ] Base
127-
* [ ] The mobile app:
128-
- [ ] has an _About_ page containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
129-
- [ ] is available for download as a release in this repo.
130-
- [ ] is available in the relevant app stores.
131-
* [ ] The web frontend:
132-
- [ ] has proper title and metadata.
133-
- [ ] has proper open graph metadata, to ensure that it is shown well when shared in social media (Discord, Telegram, Twitter, LinkedIn).
134-
- [ ] has a footer, containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
135-
- [ ] is fully static and client-side.
136-
- [ ] is deployed to Github Pages via a Github Workflow.
137-
- [ ] is accessible through the https://TODO:PROJECT-NAME.stability.nexus domain.
138-
* [ ] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
139-
140104
---
141105

142106
## Tech Stack
143107

144108
TODO:
145109

146-
### Frontend
147-
148-
TODO:
149-
150-
- Next.js 14+ (React)
151-
- TypeScript
152-
- TailwindCSS
153-
- shadcn/ui
154-
155-
### Blockchain
156-
157-
TODO:
158-
159-
- Wagmi
160-
- Solidity Smart Contracts
161-
- Ethers.js
162-
163110
---
164111

165112
## Getting Started
@@ -168,63 +115,15 @@ TODO:
168115

169116
TODO
170117

171-
- Node.js 18+
172-
- npm/yarn/pnpm
173-
- MetaMask or any other web3 wallet browser extension
174-
175118
### Installation
176119

177120
TODO
178121

179-
#### 1. Clone the Repository
180-
181-
```bash
182-
git clone https://github.com/StabilityNexus/TODO.git
183-
cd TODO
184-
```
185-
186-
#### 2. Install Dependencies
187-
188-
Using your preferred package manager:
189-
190-
```bash
191-
npm install
192-
# or
193-
yarn install
194-
# or
195-
pnpm install
196-
```
197-
198-
#### 3. Run the Development Server
199-
200-
Start the app locally:
201-
202-
```bash
203-
npm run dev
204-
# or
205-
yarn dev
206-
# or
207-
pnpm dev
208-
```
209-
210-
#### 4. Open your Browser
211-
212-
Navigate to [http://localhost:3000](http://localhost:3000) to see the application.
213-
214122
---
215123

216124
## Contributing
217125

218-
We welcome contributions of all kinds! To contribute:
219-
220-
1. Fork the repository and create your feature branch (`git checkout -b feature/AmazingFeature`).
221-
2. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
222-
3. Run the development workflow commands to ensure code quality:
223-
- `npm run format:write`
224-
- `npm run lint:fix`
225-
- `npm run typecheck`
226-
4. Push your branch (`git push origin feature/AmazingFeature`).
227-
5. Open a Pull Request for review.
126+
We welcome contributions of all kinds!
228127

229128
If you encounter bugs, need help, or have feature requests:
230129

0 commit comments

Comments
 (0)