From c0978bdf97fb34a2b463b747c917642038b01e85 Mon Sep 17 00:00:00 2001 From: Daniel D'Avella Date: Wed, 13 Dec 2023 16:27:28 -0500 Subject: [PATCH] Add FAQ --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 864e8f2..440c813 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,20 @@ brew install pixee After installation, run the `pixee` command to see instructions and options. +## F.A.Q. + +### What languages are supported for fixes? +Currently we support codemods for Java and Python. Stay tuned for additional language support at https://pixee.ai! + +### What happens to my code? +The Pixee CLI currently runs most detection and fixes locally to your own host machine. Any features that require network access to a third-party service (e.g. OpenAI) will require explicit opt-in. We promise to be transparent when this is the case. + +### How can I install the GitHub application? +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). + +### Where can I request features and report issues? +For CLI feature requests and bug reports please use our GitHub issue tracker: https://github.com/pixee/pixee-cli/issues + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md).