From a9b5d4edf50dc9c28870cd3be80e7271cc0e507f 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..6a25ca6 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? +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 all detection and fixes locally to your own host machine. No network communication is required. Eventually some CLI features may provide opt-in services that require network communication and may send code and/or metadata over the network to external services. We promise to be explicit when this is the case. + +### Where can I learn more? +Make sure to visit our website at https://pixee.ai! + +### 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).