react-epic-trails-ds/README.md

A flexible and customizable design system for React, providing pre-built UI components, typography, and themes to enhance web app development.

# React Epic Trails Design System

[![License](https://img.shields.io/npm/l/react-epic-trails-ds.svg)](https://github.com/HimanshuHegde/react-epic-trails-ds/blob/main/LICENSE)  
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)  
[![Version](https://img.shields.io/badge/version-0.0.1-orange.svg)](https://github.com/HimanshuHegde/react-epic-trails-ds)

> **Note:** This package is currently in early development (v0.0.1). APIs may change frequently.

A flexible and customizable design system for **React 18**, offering pre-built UI components, typography, and theming capabilities tailored for outdoor and adventure-themed web applications.

## 🚧 Under Development

This design system is under active development. Many features are planned but not yet implemented. Documentation and examples will expand as we progress.

## 📦 Installation

```bash
npm install react-epic-trails-ds
# or
yarn add react-epic-trails-ds
```

## 🚀 Getting Started

```tsx
import { Button } from 'react-epic-trails-ds';

export default function App() {
  return (
    <div style={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100vh' }}>
      <Button variant="primary">
        Start Exploring
      </Button>
    </div>
  );
}
```

## 🛠 Development

To contribute to the design system:

1. Clone the repository
   ```bash
   git clone https://github.com/HimanshuHegde/react-epic-trails-ds.git
   ```
2. Install dependencies
   ```bash
   npm install
   ```
3. Start the development server
   ```bash
   npm run dev
   ```

## 📚 Current Components

- **Buttons**: `Primary`, `Secondary` variants with multiple sizes (Medium, Large, Docked)
- **Tiles**: Basic content containers with various visual states

## 🗺 Roadmap

- Full component library (Inputs, Cards, Modals, etc.)
- Dark/light theme customization
- Accessibility support (WCAG AA+)
- Docs website + examples
- Interactive component playground

## 📄 License

[MIT](https://github.com/HimanshuHegde/react-epic-trails-ds/blob/main/LICENSE)

## 👥 Contributors

<div align="center">
  <a href="https://github.com/HimanshuHegde/react-epic-trails-ds/graphs/contributors">
    <img src="https://contrib.rocks/image?repo=HimanshuHegde/react-epic-trails-ds" />
  </a>
</div>

## 🤝 How to Contribute

Interested in contributing? Follow our [contribution guidelines](CONTRIBUTING.md):

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to your branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request