diff --git a/.flox/env/manifest.lock b/.flox/env/manifest.lock
index 29b8f2f..eeb51ec 100644
--- a/.flox/env/manifest.lock
+++ b/.flox/env/manifest.lock
@@ -3,14 +3,25 @@
"manifest": {
"version": 1,
"install": {
+ "coreutils": {
+ "pkg-path": "coreutils"
+ },
+ "gum": {
+ "pkg-path": "gum"
+ },
"nodejs": {
"pkg-path": "nodejs"
},
+ "vsce": {
+ "pkg-path": "vsce"
+ },
"vscode": {
"pkg-path": "vscode"
}
},
- "hook": {},
+ "hook": {
+ "on-activate": "\nexport FLOX_JAVASCRIPT_NODE_CACHE_DIR=\"$FLOX_ENV_CACHE/javascript-node\"\nmkdir -p \"$FLOX_JAVASCRIPT_NODE_CACHE_DIR\"\n\nexport FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE=\"$FLOX_JAVASCRIPT_NODE_CACHE_DIR/packages-hash\"\n\n\nfunction with_spinner() {\n if [[ \"$FLOX_ENVS_TESTING\" == \"1\" ]]; then\n bash -c \"$1\"\n else\n gum spin \\\n --show-error \\\n --spinner line \\\n --spinner.foreground=\"#cccccc\" \\\n --title \">>> $2 ...\" \\\n --title.foreground=\"#cccccc\" \\\n -- bash -c \"$1\"\n fi\n}\n\nfunction install_packages() { \n npm install\n}\nexport -f install_packages\n\n\n\nif [ -f \"package.json\" ] && [ -f \"package-lock.json\" ]; then\n export FLOX_JAVASCRIPT_NODE_PACKAGES_HASH=\"false\"\n if [ -f \"$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE\" ] ; then\n export FLOX_JAVASCRIPT_NODE_PACKAGES_HASH=$(cat package.json package-lock.json | sha256sum | cut -d\" \" -f 1)\n fi\n if [ \"$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH\" != \"$(cat $FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE 2>/dev/null)\" ]; then\n with_spinner install_packages \"Installing Javascript packages (with NPM)\"\n echo -e \"{{ Foreground \\\"#ffffff\\\" \\\"✅ Javascript packages installed (with NPM).\\\" }}\\n\" \\\n | gum format -t template\n echo \"$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH\" > \"$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE\"\n fi\nfi\n"
+ },
"profile": {},
"options": {
"systems": [
@@ -26,6 +37,252 @@
}
},
"packages": [
+ {
+ "attr_path": "coreutils",
+ "broken": false,
+ "derivation": "/nix/store/5naisiq61kp39x9mi4nnlh4h0agrv6ix-coreutils-9.5.drv",
+ "description": "GNU Core Utilities",
+ "install_id": "coreutils",
+ "license": "GPL-3.0-or-later",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "coreutils-9.5",
+ "pname": "coreutils",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "9.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "info": "/nix/store/ydfklbdc7sdv9jl2jy0prq0wa4cv2zzf-coreutils-9.5-info",
+ "out": "/nix/store/5g6np23z9q7vwwp1s5pxkgn8f8wrmihh-coreutils-9.5"
+ },
+ "system": "aarch64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "coreutils",
+ "broken": false,
+ "derivation": "/nix/store/ir8y199idsk97agpjjkxk24nrrhlygiz-coreutils-9.5.drv",
+ "description": "GNU Core Utilities",
+ "install_id": "coreutils",
+ "license": "GPL-3.0-or-later",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "coreutils-9.5",
+ "pname": "coreutils",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "9.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "debug": "/nix/store/q70vk5m0nlz0qpy7z6nfczi8ksyaszap-coreutils-9.5-debug",
+ "info": "/nix/store/cbk08ylbni3vx41g1hdd013146yvcf5c-coreutils-9.5-info",
+ "out": "/nix/store/g5manmr2a4jc9m06cf2lpnx1092wvvjh-coreutils-9.5"
+ },
+ "system": "aarch64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "coreutils",
+ "broken": false,
+ "derivation": "/nix/store/5qkwxai9nx4hszq8m25ralrg5nrjfs6n-coreutils-9.5.drv",
+ "description": "GNU Core Utilities",
+ "install_id": "coreutils",
+ "license": "GPL-3.0-or-later",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "coreutils-9.5",
+ "pname": "coreutils",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "9.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "info": "/nix/store/64g8lpl80mprjql96w0wsqc3n2q753l3-coreutils-9.5-info",
+ "out": "/nix/store/w95g6dz0b7byi4w2mgvmwpl692pilqf1-coreutils-9.5"
+ },
+ "system": "x86_64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "coreutils",
+ "broken": false,
+ "derivation": "/nix/store/gk6as4in5fphr7ds30l9cyn70icxr54a-coreutils-9.5.drv",
+ "description": "GNU Core Utilities",
+ "install_id": "coreutils",
+ "license": "GPL-3.0-or-later",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "coreutils-9.5",
+ "pname": "coreutils",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "9.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "debug": "/nix/store/h42j46bwd0fqsg70axqpkn49fzfgsxkd-coreutils-9.5-debug",
+ "info": "/nix/store/kszl2ij9l8ql5ai95h357rkwg77g2f68-coreutils-9.5-info",
+ "out": "/nix/store/k48bha2fjqzarg52picsdfwlqx75aqbb-coreutils-9.5"
+ },
+ "system": "x86_64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "gum",
+ "broken": false,
+ "derivation": "/nix/store/8psmrf1crmc3x1pdnd4pkk66gw5jh0z8-gum-0.14.5.drv",
+ "description": "Tasty Bubble Gum for your shell",
+ "install_id": "gum",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "gum-0.14.5",
+ "pname": "gum",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "0.14.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/rzqm62ixipbzbhfagqlic5xxag9a2v82-gum-0.14.5"
+ },
+ "system": "aarch64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "gum",
+ "broken": false,
+ "derivation": "/nix/store/cmqqdgyzm0p03hfk7cwb0x4x2y9s42cd-gum-0.14.5.drv",
+ "description": "Tasty Bubble Gum for your shell",
+ "install_id": "gum",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "gum-0.14.5",
+ "pname": "gum",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "0.14.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/3ick2j8z9jgkk3cyc1ik4zkbs3m4583n-gum-0.14.5"
+ },
+ "system": "aarch64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "gum",
+ "broken": false,
+ "derivation": "/nix/store/vj45dkfx974zr2f1y3mnx30xqa06p9is-gum-0.14.5.drv",
+ "description": "Tasty Bubble Gum for your shell",
+ "install_id": "gum",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "gum-0.14.5",
+ "pname": "gum",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "0.14.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/9rh8qxbxgb07v3a62mx9404ynk2yhxrj-gum-0.14.5"
+ },
+ "system": "x86_64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "gum",
+ "broken": false,
+ "derivation": "/nix/store/sxm0whwwcbs6f4ml5hw8zxfjlhlcc42k-gum-0.14.5.drv",
+ "description": "Tasty Bubble Gum for your shell",
+ "install_id": "gum",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "gum-0.14.5",
+ "pname": "gum",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "0.14.5",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/1bnivwijzrnzx5h0hd5rywwy8rlhxmw5-gum-0.14.5"
+ },
+ "system": "x86_64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
{
"attr_path": "nodejs",
"broken": false,
@@ -150,6 +407,126 @@
"group": "toplevel",
"priority": 5
},
+ {
+ "attr_path": "vsce",
+ "broken": false,
+ "derivation": "/nix/store/dj4kn9q40nqrk5jm8cywkf5lbzr1y5y5-vsce-3.1.0.drv",
+ "description": "Visual Studio Code Extension Manager",
+ "install_id": "vsce",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "vsce-3.1.0",
+ "pname": "vsce",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "3.1.0",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/hbxkg1vqpcljjs1g6imvr7d07saij9ny-vsce-3.1.0"
+ },
+ "system": "aarch64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "vsce",
+ "broken": false,
+ "derivation": "/nix/store/jw4lxg2qj74dhxg4hyyln3m2ifhj5wfa-vsce-3.1.0.drv",
+ "description": "Visual Studio Code Extension Manager",
+ "install_id": "vsce",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "vsce-3.1.0",
+ "pname": "vsce",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "3.1.0",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/lbba3s49gbrdvr1hcm0iascs15lf9qi3-vsce-3.1.0"
+ },
+ "system": "aarch64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "vsce",
+ "broken": false,
+ "derivation": "/nix/store/0gpw5nyv42pzmid9mk348h6w01zmzj4p-vsce-3.1.0.drv",
+ "description": "Visual Studio Code Extension Manager",
+ "install_id": "vsce",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "vsce-3.1.0",
+ "pname": "vsce",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "3.1.0",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/pjvrjqh76zws6lca6mqrhxqv9kmv4q1n-vsce-3.1.0"
+ },
+ "system": "x86_64-darwin",
+ "group": "toplevel",
+ "priority": 5
+ },
+ {
+ "attr_path": "vsce",
+ "broken": false,
+ "derivation": "/nix/store/sfsfjd7rcwcxyva8s3p3dfz0svcx1mr9-vsce-3.1.0.drv",
+ "description": "Visual Studio Code Extension Manager",
+ "install_id": "vsce",
+ "license": "MIT",
+ "locked_url": "https://github.com/flox/nixpkgs?rev=23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "name": "vsce-3.1.0",
+ "pname": "vsce",
+ "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+ "rev_count": 710087,
+ "rev_date": "2024-11-19T11:04:08Z",
+ "scrape_date": "2024-11-21T04:00:36Z",
+ "stabilities": [
+ "staging",
+ "unstable"
+ ],
+ "unfree": false,
+ "version": "3.1.0",
+ "outputs_to_install": [
+ "out"
+ ],
+ "outputs": {
+ "out": "/nix/store/q4hrjrjc67c22v71zmz888ckjgi6cl1g-vsce-3.1.0"
+ },
+ "system": "x86_64-linux",
+ "group": "toplevel",
+ "priority": 5
+ },
{
"attr_path": "vscode",
"broken": false,
diff --git a/.flox/env/manifest.toml b/.flox/env/manifest.toml
index 7fc14ca..0fb5cbe 100644
--- a/.flox/env/manifest.toml
+++ b/.flox/env/manifest.toml
@@ -1,60 +1,63 @@
-#
-# This is a Flox environment manifest.
-# Visit flox.dev/docs/concepts/manifest/
-# or see flox-edit(1), manifest.toml(5) for more information.
-#
-# Flox manifest version managed by Flox CLI
version = 1
-# List packages you wish to install in your environment inside
-# the `[install]` section.
[install]
vscode.pkg-path = "vscode"
nodejs.pkg-path = "nodejs"
-# hello.pkg-path = "hello"
-# nodejs = { version = "^20.15.1", pkg-path = "nodejs" }
-
-# Set environment variables in the `[vars]` section. These variables may not
-# reference one another, and are added to the environment without first
-# expanding them. They are available for use in the `[profile]` and `[hook]`
-# scripts.
-[vars]
-# message = "Howdy"
-
-# The `hook.on-activate` script is run by the *bash* shell immediately upon
-# activating an environment, and will not be invoked if Flox detects that the
-# environment has previously been activated. Variables set by the script will
-# be inherited by `[profile]` scripts defined below. Note that any stdout
-# generated by the script will be redirected to stderr.
+vsce.pkg-path = "vsce"
+
+# helper tools
+gum.pkg-path = "gum"
+coreutils.pkg-path = "coreutils"
+
[hook]
-# on-activate = '''
-# # Set variables, create files and directories
-# venv_dir="$(mktemp -d)"
-# export venv_dir
-#
-# # Perform initialization steps, e.g. create a python venv
-# python -m venv "$venv_dir"
-# '''
-
-# Scripts defined in the `[profile]` section are *sourced* by *your shell* and
-# inherit environment variables set in the `[vars]` section and by `[hook]` scripts.
-# The `profile.common` script is sourced by all shells and special care should be
-# taken to ensure compatibility with all shells, after which exactly one of
-# `profile.{bash,fish,tcsh,zsh}` is sourced by the corresponding shell.
-[profile]
-# common = '''
-# echo "it's gettin' flox in here"
-# '''
-
-# The `[services]` section of the manifest allows you to define services.
-# Services defined here use the packages provided by the `[install]` section
-# and any variables you've defined in the `[vars]` section or `hook.on-activate` script.
-[services]
-# postgres.command = "postgres --config-file=pg.conf"
-
-# Additional options can be set in the `[options]` section. Refer to
-# manifest.toml(5) for a list of available options.
+on-activate = '''
+
+export FLOX_JAVASCRIPT_NODE_CACHE_DIR="$FLOX_ENV_CACHE/javascript-node"
+mkdir -p "$FLOX_JAVASCRIPT_NODE_CACHE_DIR"
+
+export FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE="$FLOX_JAVASCRIPT_NODE_CACHE_DIR/packages-hash"
+
+
+function with_spinner() {
+ if [[ "$FLOX_ENVS_TESTING" == "1" ]]; then
+ bash -c "$1"
+ else
+ gum spin \
+ --show-error \
+ --spinner line \
+ --spinner.foreground="#cccccc" \
+ --title ">>> $2 ..." \
+ --title.foreground="#cccccc" \
+ -- bash -c "$1"
+ fi
+}
+
+function install_packages() {
+ npm install
+}
+export -f install_packages
+
+
+
+if [ -f "package.json" ] && [ -f "package-lock.json" ]; then
+ export FLOX_JAVASCRIPT_NODE_PACKAGES_HASH="false"
+ if [ -f "$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE" ] ; then
+ export FLOX_JAVASCRIPT_NODE_PACKAGES_HASH=$(cat package.json package-lock.json | sha256sum | cut -d" " -f 1)
+ fi
+ if [ "$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH" != "$(cat $FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE 2>/dev/null)" ]; then
+ with_spinner install_packages "Installing Javascript packages (with NPM)"
+ echo -e "{{ Foreground \"#ffffff\" \"✅ Javascript packages installed (with NPM).\" }}\n" \
+ | gum format -t template
+ echo "$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH" > "$FLOX_JAVASCRIPT_NODE_PACKAGES_HASH_FILE"
+ fi
+fi
+'''
+
+
[options]
-systems = ["aarch64-darwin", "aarch64-linux", "x86_64-darwin", "x86_64-linux"]
-# Uncomment to disable CUDA detection.
-# cuda-detection = false
+systems = [
+ "aarch64-darwin",
+ "aarch64-linux",
+ "x86_64-darwin",
+ "x86_64-linux",
+]
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index c0030a9..70b2345 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -53,3 +53,15 @@ jobs:
uses: "flox/activate-action@main"
with:
command: "npm run compile"
+
+ - name: "Package"
+ uses: "flox/activate-action@main"
+ with:
+ command: "vsce package --out flox-main.vsix"
+
+ - name: "Upload vscode extention as artifact"
+ uses: "actions/upload-artifact@v4"
+ with:
+ name: "flox-main.vsix"
+ path: "flox-main.vsix"
+ retention-days: 14
diff --git a/.vscodeignore b/.vscodeignore
index 7d3e5c7..1b0848a 100644
--- a/.vscodeignore
+++ b/.vscodeignore
@@ -3,6 +3,7 @@
src/**
.gitignore
.yarnrc
+.flox
vsc-extension-quickstart.md
**/tsconfig.json
**/eslint.config.mjs
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..9c8e494
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Flox VSCode Extention
+
+## Quick Start
+
+```console
+$ cd git clone git@github.com/flox/flox-vscode.git;
+$ cd flox-vscode;
+
+# Enter Dev Shell
+$ flox activate
+
+# Lint
+$ npm run compile
+
+# Run the tests
+$ npm run test
+
+# Build
+$ npm run compile
+```
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ee69c64
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright 2023 FloxDev, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 15fe92e..7a6f7d2 100644
--- a/README.md
+++ b/README.md
@@ -1,86 +1,55 @@
-# flox README
+
-This is the README for your extension "flox". After writing up a brief
-description, we recommend including the following sections.
+
+ Developer environments you can take with you
+
-## Features
+
-Describe specific features of your extension including screenshots of your
-extension in action. Image paths are relative to this README file.
+[Flox][website] is a virtual environment and package manager all in one. With
+Flox you create environments that layer and replace dependencies just where it
+matters, making them portable across the full software lifecycle.
-For example if there is an image subfolder under your extension project
-workspace:
+`flox-vscode` is a VSCode editor extension that integrated Flox environments
+with VSCode editor.
-\!\[feature X\]\(images/feature-x.png\)
+
-> Tip: Many popular extensions utilize animations. This is an excellent way to
-> show off your extension! We recommend short, focused animations that are easy
-> to follow.
+## 🤝 Found a bug? Missing a specific feature?
-## Requirements
+Feel free to [file a new issue][new-issue] with a respective title and
+description on the `flox/flox-vscode` repository. If you already found a
+solution to your problem, we would love to review your pull request!
-If you have any requirements or dependencies, add a section describing those
-and how to install and configure them.
+## ⭐️ Contribute
-## Extension Settings
+We welcome contributions to this project. Please read the [Contributor
+guide](./CONTRIBUTING.md) first.
-Include if your extension adds any VS Code settings through the
-`contributes.configuration` extension point.
+## 🪪 License
-For example:
+The Flox CLI is licensed under the GPLv2. See [LICENSE](./LICENSE).
-This extension contributes the following settings:
-* `myExtension.enable`: Enable/disable this extension.
-* `myExtension.thing`: Set to `blah` to do something.
-
-## Known Issues
-
-Calling out known issues can help limit users opening duplicate issues against
-your extension.
-
-## Release Notes
-
-Users appreciate release notes as you update your extension.
-
-### 1.0.0
-
-Initial release of ...
-
-### 1.0.1
-
-Fixed issue #.
-
-### 1.1.0
-
-Added features X, Y, and Z.
-
----
-
-## Following extension guidelines
-
-Ensure that you've read through the extensions guidelines and follow the best
-practices for creating your extension.
-
-* [Extension
-Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
-
-## Working with Markdown
-
-You can author your README using Visual Studio Code. Here are some useful
-editor keyboard shortcuts:
-
-* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
-* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and
-Linux).
-* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown
-snippets.
-
-## For more information
-
-* [Visual Studio Code's Markdown
-Support](http://code.visualstudio.com/docs/languages/markdown)
-* [Markdown Syntax
-Reference](https://help.github.com/articles/markdown-basics/)
-
-**Enjoy!**
+[website]: https://flox.dev
+[new-issue]: https://github.com/flox/flox-vscode/issues/new/choose
diff --git a/assets/flox-logo-black-on-white.png b/assets/flox-logo-black-on-white.png
new file mode 100644
index 0000000..5db27b6
Binary files /dev/null and b/assets/flox-logo-black-on-white.png differ
diff --git a/assets/flox-logo-white-on-black.png b/assets/flox-logo-white-on-black.png
new file mode 100644
index 0000000..24b9002
Binary files /dev/null and b/assets/flox-logo-white-on-black.png differ
diff --git a/package-lock.json b/package-lock.json
index b7b11d9..8d48dbd 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -7,7 +7,7 @@
"": {
"name": "flox",
"version": "1.0.0",
- "license": "???",
+ "license": "MIT",
"devDependencies": {
"@types/node": "20.x",
"@types/vscode": "^1.95.0",
diff --git a/package.json b/package.json
index 8a8ab47..375e38b 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,7 @@
}
],
"publisher": "flox",
- "license": "???",
+ "license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/flox/flox-vscode"
+