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

Update README.md #40

Closed
daxida opened this issue Nov 11, 2023 · 2 comments
Closed

Update README.md #40

daxida opened this issue Nov 11, 2023 · 2 comments
Labels
feature Feature request
Milestone

Comments

@daxida
Copy link
Collaborator

daxida commented Nov 11, 2023

Update the README with some documentation for the new justfile and other features that were implemented (clash showtest etc.).

@daxida daxida added the feature Feature request label Nov 11, 2023
@Andriamanitra
Copy link
Owner

Andriamanitra commented Nov 11, 2023

More things to document:

  • Asciinema demo of the most important commands
  • How to contribute (installing requirements, use of rustfmt, clippy, etc)
  • Generating shell completions
  • Better explanation of how the tool works (clash storage directory, downloading clashes)

@Andriamanitra Andriamanitra added this to the v1.0.0 milestone Apr 26, 2024
@Andriamanitra
Copy link
Owner

I think this issue is addressed by the updated README and the wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature request
Projects
None yet
Development

No branches or pull requests

2 participants