Smurk

Tech Stack

• ElectronJS, React, TailwindCSS

Table of Contents

• Features
• Installation
• Usage
• Contributing

Features

• Feature 1: Supports markdown on the go.
• Feature 2: Auto saving
• Feature 3: store notes based on User's main for protection
• Feature 4: Update , Create New and Delettion of Notes

Installation

To install, follow these steps:

1. Clone the repository:

   git clone https://github.com/Insomniac2904/Smurk.git

2. Navigate to the project directory:

   cd Smurk

3. Install the dependencies:

   npm install

4. To Build :

   npm run build:(your os)
   

Usage

Here's how you can use Smurk:

MarkDown.editor.app.mp4

Contributing

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-branch

3. Make your changes and commit them:

   git commit -m "Description of your changes"

4. Push to the branch:

   git push origin feature-branch

5. Open a pull request.

---