fix: correct typos and improve documentation

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dForce Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,38 +1,81 @@
-## dForce (DF) Liquidity Mining
-
-### Mainnet Contract Address(2020-08-24)
-
-<table>
-	<tr>
-        <th>Contract Name</th>
-    	<th>Contract Address</th>
-	</tr>
-	<tr>
-		<td> USDC-USDx Staking </td>
-		<td> 0xa94E2074BeB6D1Bf28014b81Ff2062eaB3600c48 </td>
-	</tr>
-	<tr>
-		<td> USDx-DF Staking </td>
-		<td> 0x5e84fC41D3aDd07A34616F781DCF1e49e8DC41C1 </td>
-	</tr>
-	<tr>
-		<td> ETH-DF Staking </td>
-		<td> 0x308777dDEC61F5000D8394626d55dbB0312fe874 </td>
-	</tr>
-	<tr>
-		<td> GOLDx-DF Staking </td>
-		<td> 0xdC7A844a45Ef936497FB916f1c2Ddb80F59a8aDc </td>
-	</tr>
-	<tr>
-		<td> dDAI Staking </td>
-		<td> 0xD2fA07cD6Cd4A5A96aa86BacfA6E50bB3aaDBA8B </td>
-	</tr>
-	<tr>
-		<td> dUSDC Staking </td>
-		<td> 0xB71dEFDd6240c45746EC58314a01dd6D833fD3b5 </td>
-	</tr>
-	<tr>
-		<td> dUSDT Staking </td>
-		<td> 0x324EebDAa45829c6A8eE903aFBc7B61AF48538df </td>
-	</tr>
-</table>
+# dForce (DF) Liquidity Mining
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ethereum](https://img.shields.io/badge/Ethereum-Mainnet-blue.svg)](https://ethereum.org/)
+
+## Overview
+
+dForce Staking is a decentralized liquidity mining protocol built on Ethereum. Users can stake their tokens in various liquidity pools to earn DF token rewards. This project includes smart contracts for staking mechanisms and a web-based frontend for user interaction.
+
+## Features
+
+- 🔒 Secure staking with audited smart contracts
+- 💰 Multiple staking pools (USDC-USDx, USDx-DF, ETH-DF, GOLDx-DF, and more)
+- 📊 Real-time reward tracking
+- 🌐 User-friendly web interface
+- ⚡ Gas-efficient contract design
+
+## Mainnet Contract Addresses (2020-08-24)
+
+| Contract Name | Contract Address |
+|--------------|------------------|
+| USDC-USDx Staking | `0xa94E2074BeB6D1Bf28014b81Ff2062eaB3600c48` |
+| USDx-DF Staking | `0x5e84fC41D3aDd07A34616F781DCF1e49e8DC41C1` |
+| ETH-DF Staking | `0x308777dDEC61F5000D8394626d55dbB0312fe874` |
+| GOLDx-DF Staking | `0xdC7A844a45Ef936497FB916f1c2Ddb80F59a8aDc` |
+| dDAI Staking | `0xD2fA07cD6Cd4A5A96aa86BacfA6E50bB3aaDBA8B` |
+| dUSDC Staking | `0xB71dEFDd6240c45746EC58314a01dd6D833fD3b5` |
+| dUSDT Staking | `0x324EebDAa45829c6A8eE903aFBc7B61AF48538df` |
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v14+)
+- npm or yarn
+- MetaMask or compatible Web3 wallet
+
+### Installation
+
+1. Clone the repository:
+   \`\`\`bash
+   git clone https://github.com/dforce-network/staking.git
+   cd staking
+   \`\`\`
+
+2. Install dependencies:
+   \`\`\`bash
+   cd web-front
+   npm install
+   \`\`\`
+
+3. Start the development server:
+   \`\`\`bash
+   npm start
+   \`\`\`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (\`git checkout -b feature/AmazingFeature\`)
+3. Commit your changes (\`git commit -m 'Add some AmazingFeature'\`)
+4. Push to the branch (\`git push origin feature/AmazingFeature\`)
+5. Open a Pull Request
+
+## Security
+
+⚠️ **Important**: This project is in beta. Use at your own risk.
+
+If you discover a security vulnerability, please report it via our official channels rather than creating a public issue.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+- [dForce Website](https://dforce.network/)
+- [Documentation](https://docs.dforce.network/)
+- [Twitter](https://twitter.com/daborce_network)

web-front/src/components/claim/claim.jsx

@@ -91,7 +91,7 @@ const styles = theme => ({
     fontWeight: '700',
     color: 'white',
   },
-  disaclaimer: {
+  disclaimer: {
     padding: '12px',
     border: '1px solid rgb(174, 174, 174)',
     borderRadius: '0.75rem',
@@ -279,7 +279,7 @@ class Claim extends Component {
 
     return (
       <div className={ classes.root }>
-        <Typography variant={'h5'} className={ classes.disaclaimer }>This project is in beta. Use at your own risk.</Typography>
+        <Typography variant={'h5'} className={ classes.disclaimer }>This project is in beta. Use at your own risk.</Typography>
         <div className={ classes.intro }>
           <Card className={ classes.addressContainer } onClick={this.overlayClicked}>
             <Typography variant={ 'h3'} className={ classes.walletTitle } noWrap>Wallet</Typography>

web-front/src/components/propose/propose.jsx

@@ -86,7 +86,7 @@ const styles = theme => ({
     fontWeight: '700',
     color: 'white',
   },
-  disaclaimer: {
+  disclaimer: {
     padding: '12px',
     border: '1px solid rgb(174, 174, 174)',
     borderRadius: '0.75rem',
@@ -199,7 +199,7 @@ class Propose extends Component {
 
     return (
       <div className={ classes.root }>
-        <Typography variant={'h5'} className={ classes.disaclaimer }>This project is in beta. Use at your own risk.</Typography>
+        <Typography variant={'h5'} className={ classes.disclaimer }>This project is in beta. Use at your own risk.</Typography>
         <div className={ classes.intro }>
           <Card className={ classes.addressContainer } onClick={this.overlayClicked}>
             <Typography variant={ 'h3'} className={ classes.walletTitle } noWrap>Wallet</Typography>

web-front/src/components/rewardPools/rewardPools.jsx

@@ -77,7 +77,7 @@ const styles = theme => ({
     fontWeight: '700',
     color: 'white',
   },
-  disaclaimer: {
+  disclaimer: {
     padding: '12px',
     border: '1px solid rgb(174, 174, 174)',
     borderRadius: '0.75rem',
@@ -510,7 +510,7 @@ class RewardPools extends Component {
     const DFPools = rewardPools.filter(rp=>rp.tokens[0].type === 'DF')
     return (
       <div className={classes.root}>
-        {/* <Typography variant={'h5'} className={classes.disaclaimer}>This project is in beta. Use at your own risk.</Typography>
+        {/* <Typography variant={'h5'} className={classes.disclaimer}>This project is in beta. Use at your own risk.</Typography>
         <div className={classes.intro}>
           <Card className={classes.addressContainer} onClick={this.overlayClicked}>
             <Typography variant={'h3'} className={classes.walletTitle} noWrap>Wallet</Typography>

web-front/src/components/stake/stake copy.jsx

@@ -87,7 +87,7 @@ const styles = theme => ({
       width: '450',
     }
   },
-  disaclaimer: {
+  disclaimer: {
     padding: '12px',
     border: '1px solid rgb(174, 174, 174)',
     borderRadius: '0.75rem',
@@ -794,7 +794,7 @@ class Stake extends Component {
       <div className={classes.root}>
         <Header show={true} address={address} overlayClicked={this.overlayClicked} cur_language={this.props.cur_language} linkTo={"/"} />
         {modalOpen && this.renderModal()}
-        {/* <Typography variant={'h5'} className={classes.disaclaimer}>This project is in beta. Use at your own risk.</Typography> */}
+        {/* <Typography variant={'h5'} className={classes.disclaimer}>This project is in beta. Use at your own risk.</Typography> */}
         {/* <div className={classes.intro}>
           <Card className={classes.addressContainer} onClick={this.overlayClicked}>
             <Typography variant={'h3'} className={classes.walletTitle} noWrap>Wallet</Typography>

web-front/src/components/stake/stake.jsx

@@ -106,7 +106,7 @@ const styles = (theme) => ({
       width: "450",
     },
   },
-  disaclaimer: {
+  disclaimer: {
     padding: "12px",
     border: "1px solid rgb(174, 174, 174)",
     borderRadius: "0.75rem",
@@ -947,7 +947,7 @@ class Stake extends Component {
           linkTo={"/"}
         />
         {modalOpen && this.renderModal()}
-        {/* <Typography variant={'h5'} className={classes.disaclaimer}>This project is in beta. Use at your own risk.</Typography> */}
+        {/* <Typography variant={'h5'} className={classes.disclaimer}>This project is in beta. Use at your own risk.</Typography> */}
         {/* <div className={classes.intro}>
           <Card className={classes.addressContainer} onClick={this.overlayClicked}>
             <Typography variant={'h3'} className={classes.walletTitle} noWrap>Wallet</Typography>

web-front/src/components/vote/vote.jsx

@@ -100,7 +100,7 @@ const styles = theme => ({
     fontWeight: '700',
     color: 'white',
   },
-  disaclaimer: {
+  disclaimer: {
     padding: '12px',
     border: '1px solid rgb(174, 174, 174)',
     borderRadius: '0.75rem',
@@ -301,7 +301,7 @@ class Vote extends Component {
 
     return (
       <div className={ classes.root }>
-        <Typography variant={'h5'} className={ classes.disaclaimer }>This project is in beta. Use at your own risk.</Typography>
+        <Typography variant={'h5'} className={ classes.disclaimer }>This project is in beta. Use at your own risk.</Typography>
         <div className={ classes.intro }>
           <Card className={ classes.addressContainer } onClick={this.overlayClicked}>
             <Typography variant={ 'h3'} className={ classes.walletTitle } noWrap>Wallet</Typography>