diff --git a/README.md b/README.md index 9ec7360..d316561 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,38 @@ +

+
+ Clippy +
+
+

+ # Clippy -A clipboard manager built on [electron](https://github.com/electron/electron/), using [WebComponents](https://developer.mozilla.org/en-US/docs/Web/Web_Components) +> A clipboard manager built on [electron](https://github.com/electron/electron/), using [WebComponents](https://developer.mozilla.org/en-US/docs/Web/Web_Components) ## Installation -> **Note:** Pre-built [binaries](https://github.com/ramlmn/electron-clippy/releases) are available for Windows only +_Linux, and Windows 7+ are supported (64-bit only)_ -Clone the repo and install dependencies -``` -$ git clone https://github.com/ramlmn/electron-clippy.git -$ cd electron-clippy -$ npm i -``` +### Linux +[**Download**](https://github.com/ramlmn/electron-clippy/releases/latest) the `.AppImage` or `.deb` file + +_The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download_ + +### Windows +[**Download**](https://github.com/ramlmn/electron-clippy/releases/latest) the `.exe` file -For running the application from console: +## Usage +By default the app would be running in the background and can be accessed by the keyboard shortcut: `Ctrl+Shift+V` + +## Dev +### Run ``` -$ npm start +$ npm install && npm start ``` -For building a binary: +### Build ``` $ npm run build ``` -The binary(for your platform) would be available in `dist` directory - -## Usage -The app is still in beta and doesn't have a feature to customize anything. -The app would be running in the system tray and can be accessed by the keyboard shortcut: `Ctrl+Shift+V` or `Cmd+Shift+V` +or check [`electron-builder` docs](https://www.electron.build/multi-platform-build) ## Acknowledgements * UI inspired from [Alfred app](https://www.alfredapp.com/) diff --git a/media/logo.svg b/media/logo.svg new file mode 100644 index 0000000..96ca895 --- /dev/null +++ b/media/logo.svg @@ -0,0 +1,12 @@ + + + + diff --git a/package.json b/package.json index cb0626d..5cf064f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "clippy", - "version": "1.0.0-alpha.3", + "version": "1.0.0-alpha.4", "description": "A clipboard manager built on electron", "license": "MIT", "repository": "ramlmn/electron-clippy", @@ -18,10 +18,10 @@ "pack": "build --dir" }, "devDependencies": { - "electron": "^1.6.11", + "electron": "1.6.13", "electron-builder": "^19.8.0", "eslint": "^4.1.1", - "eslint-config-google": "^0.8.0", + "eslint-config-google": "^0.9.1", "eslint-plugin-html": "^3.0.0" }, "build": { @@ -32,8 +32,16 @@ "node_modules", "!(*.markdown|*.md|*.txt|.*|LICENSE|README|test)" ], + "linux": { + "category": "Productivity", + "icon": "src/build-assets/icon/png", + "target": [ + "AppImage", + "deb" + ] + }, "win": { - "icon": "media/icon/clip-icon.ico", + "icon": "src/build-assets/icon/win/win.ico", "target": [ "nsis" ] diff --git a/src/build-assets/icon/png/128x128.png b/src/build-assets/icon/png/128x128.png new file mode 100644 index 0000000..d65023f Binary files /dev/null and b/src/build-assets/icon/png/128x128.png differ diff --git a/media/icon/clip-icon.ico b/src/build-assets/icon/win/win.ico similarity index 100% rename from media/icon/clip-icon.ico rename to src/build-assets/icon/win/win.ico diff --git a/src/main/main.js b/src/main/main.js index 3cf4a41..8aa9723 100644 --- a/src/main/main.js +++ b/src/main/main.js @@ -67,7 +67,6 @@ ipcMain.on('settings', handleSettings); function onClosed() { // Dereference the window - // For multiple windows store them in an array mainWindow = null; } @@ -111,7 +110,7 @@ function createMainWindow() { win.on('blur', hideWindow); const urlToLoad = url.format({ - pathname: path.join(__dirname, '..', 'renderer', 'index.html'), + pathname: path.join(__dirname, '../renderer/index.html'), protocol: 'file:', slashes: true, }); diff --git a/src/renderer/components/clippy-app.html b/src/renderer/components/clippy-app.html index 21d964f..9cd3025 100644 --- a/src/renderer/components/clippy-app.html +++ b/src/renderer/components/clippy-app.html @@ -8,12 +8,19 @@ flex-direction: column; flex: 1; background: #fff; - border-radius: .3em; overflow: hidden; + margin: 1rem; + border-radius: .3em; box-shadow: 0 0px 10px 0 rgba(0, 0, 0, .14), 0 4px 18px 0 rgba(0, 0, 0, .12), 0 3px 5px -2px rgba(0, 0, 0, .2); } + + :host(.is-linux) { + margin: 0; + box-shadow: none; + border-radius: 0; + } @@ -34,6 +41,10 @@ } ready() { + if (process.platform === 'linux') { + this.classList.add('is-linux'); + } + window.addEventListener('load', this.init); // Critical key events diff --git a/src/renderer/stylesheets/main.css b/src/renderer/stylesheets/main.css index 66c96e3..b07fa5e 100644 --- a/src/renderer/stylesheets/main.css +++ b/src/renderer/stylesheets/main.css @@ -36,7 +36,6 @@ body { line-height: 1.5; flex-direction: column; background: transparent; - padding: 1em; } .panes-container {