Skip to content

Commit 61b7ce4

Browse files
committed
chore: update README
1 parent a720ba7 commit 61b7ce4

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
</p>
44

55
<h1 align="center">massCode</h1>
6+
<p align="center">
7+
A free, open-source code snippet manager to create, organize, and instantly access your personal snippet library.
8+
</p>
69

710
<p align="center">
811
<strong>Built with Electron, Vue & Codemirror.</strong>
@@ -107,14 +110,51 @@ Handy built-in utilities for everyday dev tasks:
107110
* **Crypto & Security**: Hash/HMAC, Password Generator, UUID
108111
* **Encoders/Decoders**: URL, Base64, JSON ⇄ TOML/XML/YAML, Text ⇄ ASCII/Binary/Unicode, Color Converter
109112

110-
---
111-
112113
## Overview
113114

114115
massCode was created as a personal learning project and evolved into an open-source tool. The goal: combine the best features of snippet managers (free and paid) into one flexible, developer-friendly application.
115116

117+
## Build Locally
118+
119+
### Prerequisites
120+
121+
- Node.js (>=20.16.0)
122+
- pnpm (>= 9.0.0)
123+
124+
### Install Dependencies
125+
126+
```bash
127+
pnpm install
128+
```
129+
130+
### Build
131+
132+
To build for current platform:
133+
134+
```bash
135+
pnpm build
136+
```
137+
138+
To build for a specific platform:
139+
140+
```bash
141+
pnpm build:mac # macOS
142+
pnpm build:win # Windows
143+
pnpm build:linux # Linux
144+
```
145+
146+
### Development
147+
148+
To run in development mode:
149+
150+
```bash
151+
pnpm dev
152+
```
153+
154+
This will start the application with hot reloading.
155+
116156
## Follow
117-
- News and updates on [Twitter](https://twitter.com/anton_reshetov).
157+
- News and updates on [X](https://x.com/anton_reshetov).
118158
- [Discussions](https://github.com/massCodeIO/massCode/discussions).
119159

120160
![](.github/assets/subscribe.gif)

0 commit comments

Comments
 (0)