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

make README.md easier to parse #2228

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

mininmobile
Copy link

  • separate "getting started" from deployment instructions for laypeople who simply want to use cinny
  • break up deployment instructions so it is easier to interpret
  • remove commands for the docker pulls, as they are on the respective repositories
  • explain what hash routing is, link to all webserver config examples (assuming add example caddyfile #2227 is merged too)
  • bold pgp key dropdown to make it stand out
  • make the recommendation to use nvm a spiffy tip alert

Copy link


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@mininmobile
Copy link
Author

I have read the CLA Document and I hereby sign the CLA ✅

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