Update README

.pre-commit-config.yaml

@@ -4,7 +4,15 @@ repos:
     hooks:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+        exclude: |
+          (?x)^(
+              .*\.md
+          )$
     -   id: check-added-large-files
+        exclude: |
+          (?x)^(
+              img/demo.gif
+          )$
 -   repo: https://github.com/psf/black
     rev: 23.11.0
     hooks:

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+## Installation
+
+To install from source:
+`pip install .`
+
+For an editable installation during development:
+`pip install -e .`
+
+
+## Development
+
+To install tools for development:
+`pip install -e ".[dev]"`
+
+To enable `pre-commit` (included with development tools):
+`pre-commit install --install-hooks`
+
+To run `pre-commit` manually:
+`pre-commit run`
+
+To apply `pre-commit` to all files:
+`pre-commit run --all-files`
+
+To run a specific `pre-commit` check (e.g. `black`):
+`pre-commit run black`

README.md

@@ -1,29 +1,40 @@
-# Pixee CLI
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="img/dark_mode_logo.png">
+  <source media="(prefers-color-scheme: light)" srcset="img/light_mode_logo.png">
+  <img alt="Pixee Logo" src="img/light_mode_logo.png">
+</picture>
 
-This repository contains the implementation of the Pixee CLI.
+# Pixee is your automated product security engineer
 
-## Installation
+*Pixee fixes vulnerabilities, hardens code, squashes bugs, and gives
+engineers more time to focus on the work that counts.*
+
+The Pixee CLI brings the power of Pixee's [Codemodder framework](https://codemodder.io) to your local development environment.
+
+![Pixee CLI Demo](img/demo.gif)
 
-To install from source:
-`pip install .`
+Learn more at https://pixee.ai! 
 
-For an editable installation during development:
-`pip install -e .`
+Get the most out of Pixee by installing the Pixeebot GitHub app at
+https://app.pixee.ai. Or find us on [GitHub Marketplace](https://github.com/apps/pixeebot). 
 
+## Supported Systems:
+* MacOS (using [homebrew](https://brew.sh))
+* Linux (coming soon!)
+
+## Installation
 
-## Development
+### MacOS (using homebrew)
 
-To install tools for development:
-`pip install -e ".[dev]"`
+```
+brew tap pixee/pixee
+brew install pixee
+```
 
-To enable `pre-commit` (included with development tools):
-`pre-commit install --install-hooks`
+## Usage
 
-To run `pre-commit` manually:
-`pre-commit run`
+After installation, run the `pixee` command to see instructions and options.
 
-To apply `pre-commit` to all files:
-`pre-commit run --all-files`
 
-To run a specific `pre-commit` check (e.g. `black`):
-`pre-commit run black`
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md).