Add an initial README.md

ethereum-optimism / mocktimism

[WIP!] Coordinates two anvil process (L1 and L2) for testing / forking op-stack chains (mocktimism placeholder name)

MIT License

20 stars 6 forks source link

Add an initial README.md #58

Closed roninjin10 closed 8 months ago

roninjin10 commented 9 months ago

Description

The repo currently has no README. Add any README that describes what Mocktimism is. Information is in this issue https://github.com/ethereum-optimism/mocktimism/issues/1

Tasks

[ ] Add a README.md
[ ] Link to CONTRIBUTING.md
[ ] Include that it alpha is under construction
[ ] Add a short description of how mocktimism works

ATREAY commented 9 months ago

hey @roninjin10, can I work on this issue?

roninjin10 commented 9 months ago

@ATREAY go for it ! Let me know if you got questions

ATREAY commented 9 months ago

Hey @roninjin10, I've got a quick question. When you mentioned that issue in the description, should I just add "what Mocktimism is" to the readme file, or should I include the whole text where that part is found?

roninjin10 commented 8 months ago

@ATREAY should be a pretty short description of what mocktimism is. Feel free to leave a placeholder that I can fill in if it's not clear

ATREAY commented 8 months ago

Hey @roninjin10, I have created the readme file and included relevant information about Mocktimism. Please take a look whenever you can and let me know if any additional content should be included.