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

Revisit README #46

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Revisit README #46

merged 1 commit into from
Oct 22, 2024

Conversation

ikalnytskyi
Copy link
Owner

The README file is updated to be more coherent and easy to grasp. Among changes things are:

  • Use flat-styled badges w/ updated colors.
  • Moved tables w/ default connection parameters, inputs and outputs out of the Usage section.
  • Provide only usage examples in the Usage section.
  • Refer to the usage examples in the usage "notes" sections.
  • Provide the "recommended" way to connect.
  • Removed Python example because it's irrelevant.

The README file is updated to be more coherent and easy to grasp. Among
changes things are:

* Use flat-styled badges w/ updated colors.
* Moved tables w/ default connection parameters, inputs and outputs out
  of the Usage section.
* Provide only usage examples in the Usage section.
* Refer to the usage examples in the usage "notes" sections.
* Provide the "recommended" way to connect.
* Removed Python example because it's irrelevant.
@ikalnytskyi ikalnytskyi merged commit 7a757a6 into master Oct 22, 2024
24 checks passed
@ikalnytskyi ikalnytskyi deleted the chore/readme branch October 22, 2024 19:31
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.

1 participant