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.

Sign up for GitHub

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

Jump to bottom

README tidying #36

Merged
merged 2 commits into from
Oct 17, 2024
Merged

README tidying #36

merged 2 commits into from
Oct 17, 2024

Conversation

adam-enko
Copy link
Member

  • Apply Grazie suggestions.
  • Add links to KMP and Maven Central homepages.
  • Minor style fixes.

@adam-enko
README tidying
1d0b559 
- Apply Grazie suggestions.
- Add links to KMP and Maven Central homepages.
- Minor style fixes.
@adam-enko adam-enko requested a review from pahill October 16, 2024 14:00
pahill
pahill reviewed Oct 17, 2024
View reviewed changes
Copy link
Contributor

@pahill pahill left a comment

Choose a reason for hiding this comment

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

Just a few items - almost there! Thank you for the help thusfar

README.md Outdated Show resolved Hide resolved
README.md

### Prepare accounts and credentials

#### Register a namespace {#register-a-namespace}
#### Register a namespace
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a link to this section lower down in the doc - is this not needed?

Copy link
Member Author

@adam-enko adam-enko Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Nope :)

Maybe it's necessary in a different Markdown syntax, but for GitHub it's not needed, and it looks strange:

image

README.md
@@ -146,27 +145,30 @@ Run the following command to upload your public key using `gpg`, **substituting
gpg --keyserver keyserver.ubuntu.com --send-keys F175482952A225BFC4A07A715EE6B5F76620B385CE
```

#### Export your private key {#export-your-private-key}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this not needed to link to?

README.md Show resolved Hide resolved
pahill
pahill approved these changes Oct 17, 2024
View reviewed changes
Copy link
Contributor

@pahill pahill left a comment

Choose a reason for hiding this comment

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

Thank you!

@adam-enko adam-enko merged commit 4e78e03 into main Oct 17, 2024
5 checks passed
@adam-enko adam-enko deleted the readme_update branch October 17, 2024 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pahill pahill pahill approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@adam-enko @pahill