From 9b017c104da508d7117aa8dfd5ff6c690779410d Mon Sep 17 00:00:00 2001 From: vlad-matsiiako <78047717+vlad-matsiiako@users.noreply.github.com> Date: Thu, 17 Nov 2022 21:58:14 -0500 Subject: [PATCH] Updated Readme --- README.md | 102 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 71 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index f45dbc7c5..d72b824c8 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,80 @@ +

+ ifnisical + infisical +

-

Infisical

-

Simple, open-source, E2EE platform to sync environment variables

+

Open-source, end-to-end encrypted, 1-line-of-code tool to sync environment variables across you team and infrastructure.

-Dashboard +

+ Get Started - we host (Infisical Cloud) | + Get Started - you host | + Docs | + Website +

-[Infisical](https://infisical.com) is a simple, open source platform to help organizations manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and end-to-end encrypted. +

+ + Medusa is released under the MIT license. + + + PRs welcome! + + + Slack community channel + +

-- **User-Friendly Dashboard** to manage your organization's environment variables within projects. -- **Language-Agnostic** CLI that pulls and injects environment variables into your local workflow. -- **Authentication/Authorization** for projects (read/write controls coming soon). -- **Multiple Environments** per project (e.g. development, staging, production, etc.) -- **Personal/Shared** scoping for environment variables. -- **1-Click Deploy** to Digital Ocean (other providers coming soon). -- **Integrations** with CI/CD and production infrastructure (coming soon). -- **Automatic Secret Rotation** (coming soon). -- **2FA** (coming soon). -- **Access Logs** (coming soon). -- **Slack Integration** (coming soon). +Dashboard + +**[Infisical](https://infisical.com)** is an open source tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and end-to-end encrypted. You can start with just 1 line of code within 10 minutes. + +- **User-Friendly Dashboard** to manage your organization's environment variables within projects +- **[Language-Agnostic CLI](https://infisical.com/docs/CLI)** that pulls and injects environment variables into your local workflow +- **[Complete control over your data](https://infisical.com/docs/self_host_overview)** - host it yourself on any infrastructure +- **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.) +- **Personal/Shared** scoping for environment variables +- **[Integrations](https://infisical.com/docs/Heroku)** with CI/CD and production infrastructure (Heroku available, more coming soon) +- **[1-Click Deploy](https://infisical.com/docs/linux)** to Digital Ocean (other providers coming soon) +- 🔜 **Authentication/Authorization** for projects (read/write controls coming soon) +- 🔜 **Automatic Secret Rotation** (coming soon) +- 🔜 **2FA** (coming soon) +- 🔜 **Access Logs** (coming soon) +- 🔜 **Slack Integration & MS Teams** integrations (coming soon) And more. ## What's cool about this? -XX +Infisical is the first open-source end-to-end encrypted secret manager that takes less than 10 minutes to setup. -## Documentation +Yes. There are other secret managers out there. Some of them are incredibly complicated - they were built for security teams, not developers. The other ones are not end-to-end encrypted, and because of that they can read your secrets. If you care about efficiency and security at the same time - Infisical is right for you. + +On top of that, Infisical is one of the few open source solutions. Need any integrations or want a new feature? You can [create an issue for us](https://github.com/Infisical/infisical/issues) or contribute directly! This is the power of open-source. :) + +## Contributing For full documentation, visit [infisical.com/docs](https://infisical.com/docs). -To see how to contribute, visit [Getting Started](./DEVELOPERS.md). +Whether it's big or small, we ❤️ contributions. Check out our guide to see how to [get started](./DEVELOPERS.md). + +Not sure where to get started? [Book a free, non-pressure pairing sessions with one of our teammates](mailto:tony@infisical.com?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!)! + +## Community & Support + +- [GitHub Discussions](https://github.com/Infisical/infisical/discussions) for help with building and discussion. +- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) for any bugs and errors you encounter using Infisical. +- [Community Slack](https://join.slack.com/t/infisical/shared_invite/zt-1dgg63ln8-G7PCNJdCymAT9YF3j1ewVA) for hanging out with the community and quick communication with the team. + +## Status + +- [x] Public Alpha: Anyone can sign up over at [infisical.com](https://infisical.com) but go easy on us, there are kinks and we're just getting started. +- [ ] Public Beta: Stable enough for most non-enterprise use-cases. +- [ ] Public: Production-ready. ## Integrations -We're currently setting the foundation and building integrations so secrets can be synced everywhere. +We're currently setting the foundation and building integrations so secrets can be synced everywhere. Any help is welcome! :) - [x] Docker - [x] Docker Compose @@ -47,17 +88,6 @@ We're currently setting the foundation and building integrations so secrets can - [ ] GitLab - [ ] CircleCI -## Community & Support - -- [Community Forum]() for help with building and discussion. -- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) for any bugs and errors you encounter using Infisical. -- [Slack](https://infisical.slack.com/ssb/redirect) for hanging out with the community and quick communication with the team. - -## Status - -- [x] Public Alpha: Anyone can sign up over at [infisical.com](https://infisical.com) but go easy on us, there are kinks and we're just getting started. -- [ ] Public Beta: Stable enough for most non-enterprise use-cases. -- [ ] Public: Production-ready. We're currently in Public Alpha. @@ -67,4 +97,14 @@ This repo is entirely MIT licensed, with the exception of the `ee` directory whi ## Security -Looking to report a security vulnerability? Please refer to our [SECURITY.md](./SECURITY.md) file. +Looking to report a security vulnerability? Please don't post about it in GitHub issue. Instead, refer to our [SECURITY.md](./SECURITY.md) file. + + +## Contributors 🦸 + +[//]: contributor-faces + + + + +