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

better readme and doc #70

Closed
banditopazzo opened this issue Oct 6, 2022 · 0 comments · Fixed by #83
Closed

better readme and doc #70

banditopazzo opened this issue Oct 6, 2022 · 0 comments · Fixed by #83
Assignees
@banditopazzo
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Q4 2022

Comments

@banditopazzo
Copy link
Member

the readme and the documentation need some improvements

some of the information on the readme should be moved to the documentation to avoid maintaining stuff on two places

in particular the quick start should be a real quick start without sources compilation, we need a docker image and/or an auto install script you can fetch with curl
@banditopazzo banditopazzo self-assigned this Oct 6, 2022
@banditopazzo banditopazzo added this to the Q4 2022 milestone Oct 6, 2022
@banditopazzo banditopazzo added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 6, 2022
giovannialberto added a commit that referenced this issue Oct 12, 2022
@giovannialberto
docs(readme): add main description of what pulsar can do (see #70)
9118380
@banditopazzo banditopazzo mentioned this issue Oct 14, 2022
Merged
4 tasks
banditopazzo pushed a commit that referenced this issue Oct 18, 2022
@giovannialberto @banditopazzo
docs(readme): add main description of what pulsar can do (see #70)
6454742
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@banditopazzo banditopazzo

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Pulsar
Status: ✅ Done
Milestone
Q4 2022
Development

Successfully merging a pull request may close this issue.

Readme update / Installer exein-io/pulsar
1 participant
@banditopazzo