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

Add example config file in README #6

Closed
valentinocossar opened this issue Mar 15, 2021 · 2 comments · Fixed by #21
Closed

Add example config file in README #6

valentinocossar opened this issue Mar 15, 2021 · 2 comments · Fixed by #21
Assignees
@valentinocossar
Labels
documentation Improvements or additions to documentation

Comments

@valentinocossar
Copy link
Contributor

Add example config file in README to allow simple copy/paste if someone doesn't want to rely on the config file auto-creation feature.
@valentinocossar valentinocossar added the enhancement New feature or request label Mar 15, 2021
@valentinocossar valentinocossar self-assigned this Mar 15, 2021
@CasvalDOT
Copy link
Contributor

CasvalDOT commented Mar 16, 2021 •
edited
Loading

Maybe an animated GIF or asciinema recorded session can be useful.
We can also improve the aesthetic of the README adding a banner image on top of the page.

@valentinocossar
Copy link
Contributor Author

Sure, but I don't think a video on how to configure the file is the best approach to solve this. Certainly, we can use asciinema recorded session to better explain the CLI usage.

@CasvalDOT CasvalDOT added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 16, 2021
@valentinocossar valentinocossar mentioned this issue Apr 11, 2021
Merged
CasvalDOT pushed a commit that referenced this issue Apr 12, 2021
@valentinocossar @CasvalDOT
refactor: rewrite README and add example config file #6
5bb8458
@CasvalDOT CasvalDOT linked a pull request Apr 12, 2021 that will close this issue
New features for next release #21
Merged
CasvalDOT pushed a commit that referenced this issue Apr 12, 2021
@valentinocossar @CasvalDOT
refactor: rewrite README and add example config file #6
2a99d23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@valentinocossar valentinocossar

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New features for next release beliven-it/hssh
2 participants
@valentinocossar @CasvalDOT