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

Add list of client libraries to README #383

Merged
merged 1 commit into from
Sep 4, 2020

Conversation

SeanKilleen
Copy link
Contributor

Description

Adds a list of currently existing client libraries to the README file for the overall Flagr project.

Motivation and Context

This makes it clear which languages might still benefit from implementation, and allows a central place to find client libraries even if they're not officially supported (a field could be added to denote official support later).

How Has This Been Tested?

Markdown preview within GitHub.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

None of the above. Minor docs change.

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codecov-commenter
Copy link

Codecov Report

Merging #383 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #383   +/-   ##
=======================================
  Coverage   83.01%   83.01%           
=======================================
  Files          27       27           
  Lines        1755     1755           
=======================================
  Hits         1457     1457           
  Misses        214      214           
  Partials       84       84           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea10604...845f22f. Read the comment docs.

@zhouzhuojie
Copy link
Collaborator

Related to #378, I think we can add the list of clients (including all the community generated clients) to the docs - or even better, a dedicated page for SDK/clients and how to generate them from the openapi(swagger) spec.

https://github.com/checkr/flagr/blob/master/docs/_sidebar.md
https://checkr.github.io/flagr/#/

@zhouzhuojie zhouzhuojie merged commit fd42ba8 into openflagr:master Sep 4, 2020
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.

4 participants