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

Merged
merged 1 commit into from
Feb 28, 2025
Merged

make README.md easier to parse #2228

merged 1 commit into from
Feb 28, 2025

Conversation

mininmobile
Copy link
Contributor

  • 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

github-actions bot commented Feb 24, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@mininmobile
Copy link
Contributor Author

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

@kfiven
Copy link
Collaborator

kfiven commented Feb 25, 2025

The changes looks good @mininmobile , could you please comment recheck so that all checks can pass?

@mininmobile
Copy link
Contributor Author

recheck

ajbura added a commit to cinnyapp/cla that referenced this pull request Feb 25, 2025
Copy link

Preview: https://2228--pr-cinny.netlify.app
⚠️ Exercise caution. Use test accounts. ⚠️

@kfiven kfiven merged commit 36a8ce5 into cinnyapp:dev Feb 28, 2025
2 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants