diff --git a/README.md b/README.md index a9a4cb6..3578850 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,23 @@ -# world-engine-cli -world-engine-cli +## World CLI -temporary testing notes: +World CLI is a swiss army knife for creating, managing, and deploying World Engine projects. -install this to add new commands to the cli: -`go install github.com/spf13/cobra-cli@latest` +Key features include: -Then run: -`cobra-cli add create -p 'configCmd` to add a command line parameter "create" with an option "-p" that takes an argument 'configCmd' +- **Create** — Initialize a new World Engine project based on [starter-game-template](https://github.com/Argus-Labs/starter-game-template) +- **Dev Mode** — Run your game shard in dev mode (with editor support) for fast iteration +- **[Soon] Deploy** — Get a prod-ready World Engine deployment in the cloud easier than deploying a smart contract. -see newProject.go to see how this CLI utilizes these libraries to construct a TUI after a command has been run: -- https://github.com/charmbracelet/lipgloss for terminal rendering -- https://github.com/charmbracelet/bubbletea for the tui framework -- https://github.com/charmbracelet/bubbles for tui widgets that work with bubbletea +**Need help getting started with World Engine?** Check out the [World Engine docs](https://world.dev)! -All this thing currently does is clone the starter-game-template. +## Installation -Test with these commands; in the project dir run: -1. `go build` -2. `./world create myproject` - -## Install Pre-compiled Binaries - -The simplest, cross-platform way to get started is to download `world-cli` from [GitHub Releases](https://github.com/Argus-Labs/world-cli/releases) and place the executable file in your PATH, or using installer script below: - -- Install latest available release: +**Install latest release** ``` curl https://install.world.dev/cli! | bash ``` -- Install specific release tag: +**Install a specific release** ``` -curl https://install.world.dev/cli@! | bash +curl https://install.world.dev/cli@! | bash ```