Skip to content

fix: correct typos and improve documentation#6

Open
phessophissy wants to merge 19 commits intodforce-network:masterfrom
phessophissy:fix/docs-and-typos
Open

fix: correct typos and improve documentation#6
phessophissy wants to merge 19 commits intodforce-network:masterfrom
phessophissy:fix/docs-and-typos

Conversation

@phessophissy
Copy link
Copy Markdown

Summary

This PR fixes typos across multiple component files and significantly improves project documentation by adding a LICENSE file and enhancing the README.

Changes

Typo Fixes
Fixed disaclaimerdisclaimer typo in the following components:

  • web-front/src/components/stake/stake.jsx
  • web-front/src/components/stake/stake copy.jsx
  • web-front/src/components/vote/vote.jsx
  • web-front/src/components/propose/propose.jsx
  • web-front/src/components/claim/claim.jsx
  • web-front/src/components/rewardPools/rewardPools.jsx

Added LICENSE

Added MIT License file to clearly define the project's licensing terms.

README Improvements

  • Added badges (License, Ethereum Mainnet)
  • Added project overview and description
  • Added features section
  • Converted contract addresses from HTML table to Markdown table
  • Added Getting Started guide with prerequisites and installation steps
  • Added Contributing guidelines
  • Added Security notice
  • Added License section with link
  • Added useful links (website, docs, Twitter)

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my changes
  • My changes generate no new warnings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant