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

A few improvements to the repo README #216

Merged
merged 4 commits into from
Jul 12, 2023
Merged

A few improvements to the repo README #216

merged 4 commits into from
Jul 12, 2023

Conversation

etpinard
Copy link
Collaborator

The repo README was getting pretty out-of-date.

Commit e551885 effectively closes #154

as use in the plotly/dash README
- move up project description
- drop reference to 2+ year old Python version that added support Julia/R components creation
- use `julia` code snippets instead of `jldoctest` for better highlighting
- use Input/State splat style over `[Inputs]`, `[States]` style
- drop info on the `dash` constructor which was mostly outdated and too advanced for a README
- add more info on JSON3 serialization
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 12, 2023
@etpinard
Copy link
Collaborator Author

I'll go ahead and merge this to make this part of the v1.3.0 release.

Don't hesitate to send suggestions on how make other improvements to the README!

@etpinard etpinard merged commit d253af6 into dev Jul 12, 2023
11 checks passed
@etpinard etpinard deleted the improve-README branch July 12, 2023 15:43
@etpinard etpinard mentioned this pull request Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
1 participant