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

docs: Added a description of Offer Up and instructions to install in ReadMe.md #82

Merged
2 commits merged into from
May 10, 2024

Conversation

ghost
Copy link

@ghost ghost commented May 10, 2024

The ReadMe.md file at the root is edited. Here is a summary:

  1. A proper description of the repo was missing from the readme.md so I used a paraphrased version of the description provided in the getting-started tutorial.
  2. The link to image "https://docs.agoric.com/assets/img/new_002_small2.2dfb7462.png" was broken. It is replaced with an image of the dapp UI.
  3. I expanded a bit on the getting started subsection. A concise version of the instructions to install and start contract are provided. This is again a summarized version of the instructions provided in the tutorial.
  4. In the testing section of the readme.md file, instructions to run unit tests and end-to-end tests is provided.
  5. The links provided in Contributing subsections were a bit confusing to new devs therefore they are removed.

@ghost ghost requested a review from dckc May 10, 2024 06:10
Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very nice!

@ghost ghost force-pushed the ms-UpdatesToReadMe branch from ad32c0c to 88c14ea Compare May 10, 2024 07:46
@ghost ghost merged commit 7074e5d into main May 10, 2024
2 checks passed
@ghost ghost deleted the ms-UpdatesToReadMe branch May 10, 2024 07:52
This pull request was closed.
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.

3 participants