Skip to content
This repository was archived by the owner on Sep 5, 2022. It is now read-only.

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
slavovojacek committed Jul 24, 2021
1 parent fc868a1 commit a40929e
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 164 deletions.
15 changes: 15 additions & 0 deletions .github/assets/snip-social-cover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Sniptt
Copyright (c) 2021 Sniptt <[email protected]> (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
Expand Down
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
<p align="center" style="text-align:center;">
<p align="center">
<a href="https://sniptt.com">
<img src="./assets/readme-hero-logo.svg" alt="Sniptt Logo" />
<img src=".github/assets/snip-social-cover.svg" alt="Snip Logo" />
</a>
</p>

<div align="center">🔐 The secret manager that developers love!</div>
<p align="right">
<i>If you use this repo, star it ✨</i>
</p>

***

<p align="center">🔐 <b>A simple developer-friendly CLI for managing secrets</b></p>

***

**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.

***

<div align="center">
<p align="center">
<b>Please note that this project is under active development. APIs might change before version 1 is released.</b>
</div>
</p>

## Table of Contents

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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)
18 changes: 0 additions & 18 deletions assets/readme-hero-logo.svg

This file was deleted.

133 changes: 0 additions & 133 deletions docs/manual-install.md

This file was deleted.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -24,10 +24,10 @@
"secrets",
"sharing-secrets"
],
"author": "sniptt.com <[email protected]> (https://github.com/sniptt-official)",
"author": "Sniptt <[email protected]> (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",
Expand Down

0 comments on commit a40929e

Please sign in to comment.