Skip to content

Improve README documentation #36

@Mechack08

Description

@Mechack08

Description

The current README is minimal and only includes Nix development setup instructions. It lacks essential information for new contributors and developers who want to get started with the project.

Problem

  • No clear project overview or purpose
  • Missing installation instructions for npm/yarn users
  • No documentation of available scripts
  • No contribution guidelines
  • No project structure explanation
  • Missing links to related resources

Proposed Solution

Create a comprehensive README that includes:

  • Project overview and purpose
  • Prerequisites (Node.js version requirements)
  • Installation instructions for both npm and Nix users
  • Table of available npm scripts with descriptions
  • Project structure overview
  • Development workflow guide
  • Contributing guidelines
  • Technology stack information
  • Useful links (live site, docs, etc.)
  • License and support information

Benefits

  • Easier onboarding for new contributors
  • Better discoverability of project features
  • Clear contribution guidelines
  • Improved project professionalism

Additional Context

This is a great first issue for new contributors to get familiar with the project structure and documentation practices.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions