From a40929e6360c84c2b60e80b51dc178e3d8f5b48a Mon Sep 17 00:00:00 2001 From: Slavo Vojacek Date: Sat, 24 Jul 2021 17:38:03 +0100 Subject: [PATCH] chore(readme): update readme --- .github/assets/snip-social-cover.svg | 15 +++ LICENSE | 2 +- README.md | 22 +++-- assets/readme-hero-logo.svg | 18 ---- docs/manual-install.md | 133 --------------------------- package.json | 8 +- 6 files changed, 34 insertions(+), 164 deletions(-) create mode 100644 .github/assets/snip-social-cover.svg delete mode 100644 assets/readme-hero-logo.svg delete mode 100644 docs/manual-install.md diff --git a/.github/assets/snip-social-cover.svg b/.github/assets/snip-social-cover.svg new file mode 100644 index 0000000..e2bb977 --- /dev/null +++ b/.github/assets/snip-social-cover.svg @@ -0,0 +1,15 @@ + + + snip-social-cover + + + + + + + + + + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE index 434781b..18772b9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Sniptt +Copyright (c) 2021 Sniptt (sniptt.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 8b6c85e..b4055c5 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,28 @@ -

+

- Sniptt Logo + Snip Logo

-
🔐 The secret manager that developers love!
+

+ If you use this repo, star it ✨ +

+ +*** + +

🔐 A simple developer-friendly CLI for managing secrets

*** **Looking to share end-to-end encrypted secrets via a one-time URL?** -⚡️ Check out **[ots-cli](https://github.com/sniptt-official/ots-cli)** - our zero-configuration, light-weight CLI written in Go and designed specifically for fast and secure sharing of one-time secrets. +⚡️ Check out **[ots](https://github.com/sniptt-official/ots)** - our zero-configuration, light-weight CLI written in Go and designed specifically for fast and secure sharing of one-time secrets. *** -
+

Please note that this project is under active development. APIs might change before version 1 is released. -

+

## Table of Contents @@ -88,7 +94,7 @@ npm install sniptt -g ### Manual -For manual installation instructions on macOS and Linux, please refer to the dedicated [install docs](./docs/manual-install.md). +See [Releases](https://github.com/sniptt-official/snip/releases) ## Features @@ -270,4 +276,4 @@ Our platform is built on AWS, using 100% serverless architecture. We rely heavil ## License -This project is under the MIT license. +See [LICENSE](LICENSE) diff --git a/assets/readme-hero-logo.svg b/assets/readme-hero-logo.svg deleted file mode 100644 index ab8d4e5..0000000 --- a/assets/readme-hero-logo.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - Custom Preset 3 - - - - - - - - - - - - - - - diff --git a/docs/manual-install.md b/docs/manual-install.md deleted file mode 100644 index 292b09d..0000000 --- a/docs/manual-install.md +++ /dev/null @@ -1,133 +0,0 @@ -# Manual install - -## macOS manual install - -1. Download the tarball using the `curl` command. The `-o` option specifies the file name that the downloaded tarball is written to. In this example, the file is written to `snip.tar.gz` in the current folder. - -```sh -$ curl -L https://github.com/sniptt-official/snip-cli/releases/download/v0.0.50/snip-macos-x64.tar.gz -o snip.tar.gz -``` - -NOTE: You can install to any folder, or choose the recommended `/usr/local/snip-cli`. - -To verify the integrity of the tarball, run the following command and check that the output matches the one on the relevant [release page](https://github.com/sniptt-official/snip-cli/releases/tag/v0.0.50). - -```sh -$ sha256sum snip.tar.gz -``` - -2. Extract the binary. - -```sh -$ tar -xf snip.tar.gz -``` - -3. Create a symlink to the user's `bin` folder. - -```sh -$ sudo ln -sf snip /usr/local/bin/snip -``` - -NOTE: You must have write permissions to the specified folder. Creating a symlink to a folder that is already in your path eliminates the need to add the install folder to the user's `$PATH` variable. - -4. Verify the installation. - -Assuming `/usr/local/bin` is on your `PATH`, you can now run: - -```sh -$ snip --version -``` - -### Uninstall - -1. Find the folder that contains the symlink to the main binary. - -```sh -$ which snip -/usr/local/bin/snip -``` - -2. Using that information, run the following command to find the installation folder that the symlink points to. - -```sh -$ ls -l /usr/local/bin/snip -lrwxr-xr-x 1 user admin 4 4 Jun 16:20 /usr/local/bin/snip -> /folder/installed/snip-cli/snip -``` - -3. Delete the symlink in the first folder. If your user account already has write permission to this folder, you don't need to use `sudo`. - -```sh -$ sudo rm /usr/local/bin/snip -``` - -4. Delete the main installation folder. - -```sh -$ rm -rf /folder/installed/snip-cli -``` - -## Linux manual install - -1. Download the tarball using the `curl` command. The `-o` option specifies the file name that the downloaded tarball is written to. In this example, the file is written to `snip.tar.gz` in the current directory. - -```sh -$ curl -L https://github.com/sniptt-official/snip-cli/releases/download/v0.0.50/snip-linux-x64.tar.gz -o snip.tar.gz -``` - -NOTE: You can install to any directory, or choose the recommended `/usr/local/snip-cli`. - -To verify the integrity of the tarball, run the following command and check that the output matches the one on the relevant [release page](https://github.com/sniptt-official/snip-cli/releases/tag/v0.0.50). - -```sh -$ shasum -a 256 snip.tar.gz -``` - -2. Extract the binary. - -```sh -$ tar -xf snip.tar.gz -``` - -3. Create a symlink to the user's `bin` directory. - -```sh -$ sudo ln -sf snip /usr/local/bin/snip -``` - -NOTE: You must have write permissions to the specified directory. Creating a symlink to a directory that is already in your path eliminates the need to add the install directory to the user's `$PATH` variable. - -4. Verify the installation. - -Assuming `/usr/local/bin` is on your `PATH`, you can now run: - -```sh -$ snip --version -``` - -### Uninstall - -1. Find the directory that contains the symlink to the main binary. - -```sh -$ which snip -/usr/local/bin/snip -``` - -2. Using that information, run the following command to find the installation directory that the symlink points to. - -```sh -$ ls -l /usr/local/bin/snip -lrwxr-xr-x 1 user admin 4 4 Jun 16:20 /usr/local/bin/snip -> /directory/installed/snip-cli/snip -``` - -3. Delete the symlink in the first directory. If your user account already has write permission to this directory, you don't need to use `sudo`. - -```sh -$ sudo rm /usr/local/bin/snip -``` - -4. Delete the main installation directory. - -```sh -$ rm -rf /directory/installed/snip-cli -``` diff --git a/package.json b/package.json index cf6f342..e440ec0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "sniptt", "version": "0.0.50", - "description": "The secret manager that developers love!", + "description": "A simple developer-friendly CLI for managing secrets", "main": "./build/cli.js", "bin": { "sniptt": "./build/cli.js", @@ -24,10 +24,10 @@ "secrets", "sharing-secrets" ], - "author": "sniptt.com (https://github.com/sniptt-official)", + "author": "Sniptt (sniptt.com)", "license": "MIT", - "homepage": "https://github.com/sniptt-official/snip-cli", - "bugs": "https://github.com/sniptt-official/snip-cli/issues", + "homepage": "https://github.com/sniptt-official/snip", + "bugs": "https://github.com/sniptt-official/snip/issues", "scripts": { "test": "ava", "test:ci": "nyc ava --fail-fast",