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

Improve the README.md #31

Open
michael-gelfand opened this issue Feb 27, 2025 · 0 comments
Open

Improve the README.md #31

michael-gelfand opened this issue Feb 27, 2025 · 0 comments
Assignees
@halaarar
Labels
documentation Improvements or additions to documentation
Milestone
Milestone 2

Comments

@michael-gelfand
Copy link
Collaborator

We should update the readme to include more documentation focused on two specific groups

Those interested in using our dashboard

  • Include motivation behind the project and clearly explain what problem we are solving and why it is important.
  • High level usage instructions.
    • What you can do in our dashboard
    • Deployed link
  • Include a link to the demo GIF
  • Include a note on how to get support (e.g. opening an issue)

Those interested in running the app locally and potentially helping with development

  • How to install app
  • Dependencies required to run locally
  • Include a link to the contributing file
@michael-gelfand michael-gelfand added the documentation Improvements or additions to documentation label Feb 27, 2025
@michael-gelfand michael-gelfand added this to the Milestone 2 milestone Feb 27, 2025
@halaarar halaarar self-assigned this Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@halaarar halaarar

Labels
documentation Improvements or additions to documentation
Projects
NYC Arrest Tracker
Status: No status
Milestone
Milestone 2
Development

No branches or pull requests
2 participants
@michael-gelfand @halaarar