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

first update to README - formatting + Overview, Installation, Testing #37

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

jGaboardi
Copy link
Collaborator

@jGaboardi jGaboardi commented Jun 11, 2024

first update to README

  • formatting
  • Overview
  • Installation
  • Testing
  • badges for release, CI status, & code coverage

xref #35

@carsonfarmer I took some liberties with reformatting of lists, etc. Please give blunt feedback and guidance if it's not something you think looks nice.

@jGaboardi jGaboardi self-assigned this Jun 11, 2024
@jGaboardi jGaboardi added the docs label Jun 11, 2024
@jGaboardi
Copy link
Collaborator Author

xref #20

Copy link
Owner

@carsonfarmer carsonfarmer left a comment

Choose a reason for hiding this comment

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

Lovely


```bash
pip install -r recommended.txt
py.test fastpair
pip install -e .[tests]
Copy link
Owner

Choose a reason for hiding this comment

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

So cool!

@jGaboardi jGaboardi merged commit 5f8e7a5 into carsonfarmer:main Jun 11, 2024
8 checks passed
@jGaboardi jGaboardi deleted the first_update_to_readme branch June 11, 2024 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants