Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update package.json and README.md #132

Merged
merged 2 commits into from
Sep 25, 2024
Merged

chore: update package.json and README.md #132

merged 2 commits into from
Sep 25, 2024

Conversation

3esmit
Copy link
Collaborator

@3esmit 3esmit commented Sep 24, 2024

Description

This should make project more good looking.

Updates package.json with:

  • new gas-report: uses stderr to allow work on non interactive terminals
  • faster adorno: avoid testing contracts 2 times
  • updates author: Add IFT data
  • add engine: set engine to be at least node 18
  • add repository
  • add bugs

Updates README.md

Add actual information on this project, removing the template readme.

Fixes #131

Checklist

Ensure you completed all of the steps below before submitting your pull request:

  • Added natspec comments?
  • Ran forge snapshot?
  • Ran pnpm gas-report?
  • Ran pnpm lint?
  • Ran forge test?
  • Ran pnpm verify?

@3esmit 3esmit requested a review from 0x-r4bbit September 24, 2024 15:03
@3esmit 3esmit changed the title chore: update project description and author information, update READ… chore: update package.json and README.md Sep 24, 2024
@3esmit 3esmit self-assigned this Sep 24, 2024
@3esmit
Copy link
Collaborator Author

3esmit commented Sep 25, 2024

I'll add more text to features, just noticed I missed an important features which is migration system. I'll review this tomorrow morning. If you have any other ideas on what to put on read me let me know

@0x-r4bbit
Copy link
Collaborator

This PR should not include any changes to the gas reports.

@3esmit
Copy link
Collaborator Author

3esmit commented Sep 25, 2024

This is happening because of #133, once we fix that this should stop happening. My commits automatically include gas reports if they change. Do you prefer fixing #133 first than coming to this issue?

@0x-r4bbit
Copy link
Collaborator

I don't think changes to the readme and package.json should be blocked by the gas-reports changing due to fuzzing.
So let's merge this.

Thank you for doing this!

@3esmit
Copy link
Collaborator Author

3esmit commented Sep 25, 2024

I'll just add something on readme...

@0x-r4bbit 0x-r4bbit merged commit 097bd05 into develop Sep 25, 2024
8 checks passed
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.

Readme and package.json need maintance
2 participants