zurik 1.0.0 → 1.0.2

package/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install deps
+        run: npm ci
+
+      - name: Build
+        run: npm run build --if-present
+
+      - name: Publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zurik",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI tool for encrypting and decrypting sensitive project files into a single .zurik bundle.",
   "type": "module",
   "bin": {
@@ -15,7 +15,10 @@
     "git",
     "files"
   ],
-  "author": "",
-  "license": "MIT",
-  "dependencies": {}
+  "author": "Safi",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:apotox/zurik.git"
+  },
+  "license": "MIT"
 }

package/readme.md

@@ -23,3 +23,27 @@ npm install -g zurik
 # also you can pass the password as an argument
 npx zurik -e -p "your-password"
 ```
+
+## Usage
+### Encrypt files
+- create *.gitencrypt* file in the root of your project
+- add paths to files you want to encrypt, one per line
+- for example:
+```txt
+# .gitencrypt
+src/config.json
+src/secret.txt
+```
+- run the command below
+```sh
+npx zurik -e -p "your-password"
+```
+- the encrypted files will be saved in `.zurik` file
+- it will also add the encrypted files to `.gitignore` if they are not already ignored
+
+### Decrypt files
+- run the command below to decrypt the files
+```sh
+npx zurik -d -p "your-password"
+```
+- the decrypted files will be saved in the same directory as the original files