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

Clean-up ReadMe for v0.3.0 release. #242

Closed
mrbiggred opened this issue Feb 19, 2021 · 0 comments · Fixed by #250
Closed

Clean-up ReadMe for v0.3.0 release. #242

mrbiggred opened this issue Feb 19, 2021 · 0 comments · Fixed by #250
Assignees
@dfar-io
Labels
documentation Improvements or additions to documentation
Milestone
v0.3.0

Comments

@mrbiggred
Copy link
Contributor

I would like the ReadMe to be written with two audiences in mind:

  1. Developers consuming the NuGet package. This would include steps on how to install Freshli NuGet package, API documentation, and some examples.
  2. Developers that want to contribute to Freshli. How to setup your development environment, submit PR, etc. At first this will only be internal Corgi's but should be written so non-Corgi's could eventually open PRs.

This issue is to start writing the ReadMe with the above two audiences in mind. It should also list the lanagues that Freshli supports and any known issues for the upcoming v0.3.0 release.
@mrbiggred mrbiggred added the documentation Improvements or additions to documentation label Feb 19, 2021
@mrbiggred mrbiggred added this to the v0.3.0 milestone Feb 19, 2021
@dfar-io dfar-io self-assigned this Feb 23, 2021
@mrbiggred mrbiggred mentioned this issue Feb 23, 2021
Merged
@dfar-io dfar-io mentioned this issue Feb 24, 2021
Merged
@mrbiggred mrbiggred linked a pull request Feb 25, 2021 that will close this issue
Readme #250
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dfar-io dfar-io

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.3.0
Development

Successfully merging a pull request may close this issue.

Readme corgibytes/freshli-lib
2 participants
@dfar-io @mrbiggred