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

Updating README #175

Merged
merged 3 commits into from
Dec 14, 2021
Merged

Updating README #175

merged 3 commits into from
Dec 14, 2021

Conversation

roferg
Copy link
Contributor

@roferg roferg commented Dec 13, 2021 •
edited
Loading

Updating the README with basic usage documentation and links to getting started resources. Closes #68

Updating the

  • [N\A] Did you write/update appropriate tests
  • [N\A] Release notes updated (if appropriate)
  • [N\A] Appropriate logging output
  • Issue linked

@github-actions
Copy link

github-actions bot commented Dec 13, 2021 •
edited
Loading

Test Results

  1 files    1 suites   0s ⏱️
61 tests 61 ✔️ 0 💤 0 ❌

Results for commit c441b2d.

♻️ This comment has been updated with latest results.

dylan-smith
dylan-smith reviewed Dec 13, 2021
View reviewed changes
README.md Show resolved Hide resolved
@github-actions
Copy link

Code Coverage

Package Line Rate Branch Rate Complexity Health
octoshift 59% 50% 371 ➖
Summary 59% (1025 / 1748) 50% (135 / 268) 371 ➖

@roferg roferg merged commit 9bc1b26 into main Dec 14, 2021
@roferg roferg deleted the Update-Readme branch December 14, 2021 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dylan-smith dylan-smith dylan-smith 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.

Basic Usage Docs
2 participants
@roferg @dylan-smith