Skip to content

Improve README with setup and usage instructions#64

Open
AditiBS wants to merge 1 commit into
rspavithra:mainfrom
AditiBS:docs-update-readme
Open

Improve README with setup and usage instructions#64
AditiBS wants to merge 1 commit into
rspavithra:mainfrom
AditiBS:docs-update-readme

Conversation

@AditiBS
Copy link
Copy Markdown

@AditiBS AditiBS commented Feb 27, 2026

📌 Description

The current README lacked clear instructions for setting up, running, and using the NoteStack application. This made it difficult for new users and contributors to quickly understand the project.

This pull request updates the README to provide clear, concise, and beginner-friendly documentation.


🔗 Related Issue

Closes #42


🛠 Changes Made

  • Added a project overview explaining what NoteStack is and its core features
  • Added basic usage instructions (add, edit, delete, search, reorder notes, dark mode)
  • Improved readability for new users and contributors

✅ Checklist

  • I have tested my changes
  • My code follows project guidelines
  • I have linked the related issue

@github-actions github-actions Bot added documentation Improvements or additions to documentation HackTheStack labels Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation HackTheStack

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README file is missing clear setup and usage instructions

1 participant