feat: Updated README, added first configless properties to sync

Author: itpropro

README.md

@@ -1,10 +1,10 @@
 # envsync
 
+> Effortless environment file synchronization
+
 [![npm version](https://img.shields.io/npm/v/envsync?style=flat&colorA=222&colorB=448aff)](https://npmjs.com//envsync)
 [![License](https://img.shields.io/github/license/visorian/envsync?style=flat&colorA=222&colorB=448aff)](./LICENSE)
 
-> Effortless environment file synchronization and management for modern projects.
-
 > *Did you receive the .env file I shared in Discord?*
 
 **envsync** helps you keep your `.env` files in sync across local and remote backends (local, Azure Storage, Azure Key Vault, Azure App Configuration). It provides a simple CLI to initialize, sync, update, check status, and clear environment files for your project.
@@ -15,9 +15,8 @@
 
 - 🔍 **Auto-detects** `.env` files in your project (root and subfolders)
 - 🗂️ **Supports multiple backends powered by unstorage**: Currently supported Azure Storage, Azure Key Vault, Azure App Configuration
-- 📝 **Interactive CLI** for setup and management
-- 🛡️ **Respects `.gitignore`** for file discovery
-- 🔄 **Sync, update, status, and clear** commands
+- **Supports merging**: Supports merging with existing settings in .env files. Duplicate keys will be overwritten by the remote state
+- 📝 **Interactive CLI** for setup and management - Run `envsync --help` for available options
 
 ### Planned
 
@@ -27,6 +26,22 @@
 
 ---
 
+## Quickstart
+
+1. Initialize new envsync config with `envsync init`
+2. Execute `envsync update` to push the configured `.env` files to the remote location
+3. Execute `envsync sync` anywhere you want to pull the current version from the remote location
+
+### For syncing only
+
+1. Execute `envsync sync`
+
+⚠️ **Important**
+
+- The preferred way of authenticating to remote storage (for example Azure Key Vault) should be an interactive login session with `az login` or `Connect-AzAccount`. Adding more env variables to authenticate to a service is not what we want to achieve.
+- Please cofigure permissions for reading and writing with your storage provider. For example in Azure you should only provide write permissions to people you want to update the .env files by assigning the respective RBAC (Role-Based Access Control) roles.
+- Remember that secrets stored in `.env` files are unecrypted and should only be for local services or extremely temporary. They cannot be recalled once they are on someones computer.
+
 ## Install
 
 ```bash

biome.jsonc

@@ -2,7 +2,7 @@
   "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
   "formatter": {
     "enabled": true,
-    "indentStyle": "space" // default is `tab`
+    "indentStyle": "space"
   },
   "linter": {
     "enabled": true,
@@ -24,11 +24,12 @@
   },
   "json": {
     "parser": {
-      "allowComments": true,
+      "allowComments": true
     }
   },
   "javascript": {
     "formatter": {
+      "lineWidth": 100,
       "quoteStyle": "single",
       "semicolons": "asNeeded",
       "indentStyle": "space",

envsync.json

@@ -0,0 +1,30 @@
+{
+  "mergeEnvFiles": false,
+  "recursive": true,
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "backend": {
+    "type": "local",
+    "name": "local",
+    "config": {}
+  },
+  "files": [
+    {
+      "name": ".env.test",
+      "path": "test/.env.test",
+      "extension": ".test"
+    },
+    {
+      "name": ".env.test",
+      "path": "test/packages/app21/.env.test",
+      "extension": ".test"
+    },
+    {
+      "name": ".env.test",
+      "path": "test/packages/test/.env.test",
+      "extension": ".test"
+    }
+  ]
+}

package.json

@@ -37,6 +37,7 @@
     "c12": "^3.0.4",
     "consola": "^3.4.2",
     "defu": "^6.1.4",
+    "destr": "^2.0.5",
     "magicast": "^0.3.5",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",

pnpm-lock.yaml

@@ -19,16 +19,15 @@ export const { config, configFile, layers } = await loadConfig<EnvsyncConfig>({
 
 export const envsyncConfig = layers?.length ? config : undefined
 
-export function verifyConfig(
-  config: typeof envsyncConfig = envsyncConfig,
-): NonNullable<typeof envsyncConfig> {
+export function verifyConfig(config: typeof envsyncConfig = envsyncConfig): {
+  config: NonNullable<typeof envsyncConfig>
+  valid: boolean
+} {
   if (!config) {
-    consola.error(
-      'No configuration found. Please run init first or provide the required parameters.',
-    )
-    throw new Error('No configuration found.')
+    consola.error('No configuration found. Please run init first.')
+    return { config: {}, valid: false }
   }
-  return config
+  return { config, valid: true }
 }
 export function createEnvsyncConfig(config: EnvsyncConfig, pwd?: string) {
   const configPath = path.join(pwd ?? process.cwd(), 'envsync.json')