make-json-to-env 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,103 @@
+Since you requested the `.md` file, here is the raw Markdown code for your **`README.md`**. You can copy and paste this directly into your project.
+
+I’ve optimized the formatting to make it look professional on the npm registry page.
+
+```markdown
+# make-json-to-env 🚀
+
+A lightweight CLI tool to transform your `JSON` configuration files into `.env` templates instantly. Perfect for generating `.env.example` files without manual typing.
+
+---
+
+## 📦 Installation
+
+You can run it directly without installing using `npx`:
+
+```bash
+npx make-json-to-env <filename.json>
+
+```
+
+Or install it globally to use the command anywhere:
+
+```bash
+npm install -g make-json-to-env
+
+```
+
+## 🛠 Usage
+
+Once installed, use the `convert-json-env` command followed by your JSON file:
+
+### Basic Conversion
+
+```bash
+convert-json-env config.json
+
+```
+
+*This will create a `config.env` file in the same directory.*
+
+### With a Prefix
+
+Use the `--prefix` flag to prepend strings to every line (useful for shell scripts or specific frameworks).
+
+```bash
+convert-json-env firebaseConfig.json --prefix="export "
+
+```
+
+---
+
+## 📋 Example
+
+**Input (`example.json`):**
+
+```json
+{
+  "apiKey": "12345",
+  "authDomain": "app.firebaseapp.com",
+  "projectId": "my-app"
+}
+
+```
+
+**Command:**
+
+```bash
+convert-json-env example.json --prefix="export "
+
+```
+
+**Output (`example.env`):**
+
+```env
+export APIKEY=
+export AUTHDOMAIN=
+export PROJECTID=
+
+```
+
+---
+
+## ✨ Features
+
+* **No Dependencies:** Light as a feather, uses native Node.js modules.
+* **Smart Naming:** Automatically generates the output filename based on your input.
+* **Case Formatting:** Automatically converts keys to `UPPER_CASE` for standard `.env` compliance.
+* **Security First:** Helps you create `.env.example` files so you never accidentally commit your real secrets.
+
+## 📄 License
+
+[MIT](https://www.google.com/search?q=LICENSE)
+
+```
+
+---
+
+### One last tip before you publish:
+Make sure your `package.json` has the **description** and **keywords** filled out. This helps people find your package when they search on npm.
+
+**Would you like me to generate a standard MIT `LICENSE` file text for you as well?**
+
+```

package/package.json

@@ -1,12 +1,28 @@
 {
   "name": "make-json-to-env",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Generates a template .env.example from a config.json file",
   "main": "index.js",
   "bin": {
     "make-json-to-env": "./index.js"
   },
-  "keywords": ["env", "json", "converter", "template"],
+ "keywords": [
+    "env",
+    "json",
+    "converter",
+    "template",
+    "dot-env",
+    "environment-variables",
+    "config-to-env",
+    "cli",
+    "devtools",
+    "automation",
+    "boilerplate",
+    "env-example",
+    "dotenv-generator",
+    "configuration",
+    "secrets-management"
+  ],
   "author": "Your Name",
   "license": "MIT"
-}
+}