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 with installation instructions and usage examples #2

Closed
wants to merge 3 commits into from

Conversation

freddyfavour
Copy link
Contributor

  • Add detailed installation steps, including cloning the repository, installing dependencies, and running the program
  • Provide step-by-step instructions for using the anime downloader CLI
  • Include an example usage scenario to demonstrate the program's functionality
  • Update the README structure and formatting for better readability and organization

- Add detailed installation steps, including cloning the repository, installing dependencies, and running the program
- Provide step-by-step instructions for using the anime downloader CLI
- Include an example usage scenario to demonstrate the program's functionality
- Update the README structure and formatting for better readability and organization
@dev-palwar
Copy link
Owner

you need to remove the example usage scenario

@freddyfavour
Copy link
Contributor Author

I have addressed that issue :D

@dev-palwar
Copy link
Owner

Thanks for the effort, @freddyfavour! But the current README feels sufficient given the project’s simplicity and size, but there’s definitely room to expand core features. For instance:

  • Add CLI navigation for episodes, as currently, it only displays about 30.
  • Create a more native CLI experience, with navigation similar to npx shadcn@latest init.

@dev-palwar dev-palwar closed this Oct 31, 2024
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.

2 participants