diff --git a/Cargo.lock b/Cargo.lock index 4f64bfb8..967d3bfc 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3992,7 +3992,7 @@ dependencies = [ [[package]] name = "zellij" -version = "0.34.5" +version = "0.35.0" dependencies = [ "anyhow", "dialoguer", @@ -4011,7 +4011,7 @@ dependencies = [ [[package]] name = "zellij-client" -version = "0.34.5" +version = "0.35.0" dependencies = [ "insta", "log", @@ -4025,7 +4025,7 @@ dependencies = [ [[package]] name = "zellij-server" -version = "0.34.5" +version = "0.35.0" dependencies = [ "ansi_term", "arrayvec 0.7.2", @@ -4055,7 +4055,7 @@ dependencies = [ [[package]] name = "zellij-tile" -version = "0.34.5" +version = "0.35.0" dependencies = [ "clap", "serde", @@ -4067,14 +4067,14 @@ dependencies = [ [[package]] name = "zellij-tile-utils" -version = "0.34.5" +version = "0.35.0" dependencies = [ "ansi_term", ] [[package]] name = "zellij-utils" -version = "0.34.5" +version = "0.35.0" dependencies = [ "anyhow", "async-std", diff --git a/Cargo.toml b/Cargo.toml index 2fba0f48..388827a1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij" -version = "0.34.5" +version = "0.35.0" authors = ["Aram Drevekenin "] edition = "2021" description = "A terminal workspace with batteries included" @@ -17,9 +17,9 @@ anyhow = "1.0" thiserror = "1.0.30" names = { version = "0.13.0", default-features = false } miette = { version = "3.3.0", features = ["fancy"] } -zellij-client = { path = "zellij-client/", version = "0.34.5" } -zellij-server = { path = "zellij-server/", version = "0.34.5" } -zellij-utils = { path = "zellij-utils/", version = "0.34.5" } +zellij-client = { path = "zellij-client/", version = "0.35.0" } +zellij-server = { path = "zellij-server/", version = "0.35.0" } +zellij-utils = { path = "zellij-utils/", version = "0.35.0" } log = "0.4.17" dialoguer = "0.10.1" suggest = "0.4" diff --git a/README.md b/README.md index f31f4dfe..1b8ffc6b 100644 --- a/README.md +++ b/README.md @@ -19,41 +19,36 @@

[Installation] - [Overview] + [Screencasts & Tutorials] [Configuration] - [Templates] + [Layouts] [FAQ]

# What is this? -[Zellij](https://en.wikipedia.org/wiki/Zellij) is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal. -At its core, it is a terminal multiplexer (similar to [tmux](https://github.com/tmux/tmux) and [GNU Screen](https://www.gnu.org/software/screen/)), but this is merely its infrastructure layer. +[Zellij](https://en.wikipedia.org/wiki/Zellij) is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal. Similar programs are sometimes called "Terminal Multiplexers". -Zellij includes a [layout system](https://zellij.dev/documentation/layouts.html), and a [plugin system](https://zellij.dev/documentation/plugins.html) allowing one to create plugins in any language that compiles to WebAssembly. +Zellij is designed around the philosophy that one must not sacrifice simplicity for power, taking pride in its great experience out of the box as well as the advanced features it places at its users' fingertips. -You can get started by [installing](https://zellij.dev/documentation/installation.html) Zellij and reading the [overview](https://zellij.dev/documentation/overview.html). +Zellij is geared toward beginner and power users alike - allowing deep customizability, personal automation through [layouts](https://zellij.dev/documentation/layouts.html), true multiplayer collaboration, unique UX features such as floating and stacked panes, and a [plugin system](https://zellij.dev/documentation/plugins.html) allowing one to create plugins in any language that compiles to WebAssembly. + +You can get started by [installing](https://zellij.dev/documentation/installation.html) Zellij and checking out the [Screencasts & Tutorials](https://zellij.dev/screencasts/). For more details about our future plans, read about upcoming features in our [roadmap](#roadmap). -Zellij was initially called ***Mosaic***. - ## How do I install it? -You can install with `cargo`: +The easiest way to install Zellij is through a [package for your OS](./docs/THIRD_PARTY_INSTALL.md). + +If one is not available for your OS, you could download a prebuilt binary from the [latest release](https://github.com/zellij-org/zellij/releases/latest) and place it in your `$PATH`. If you'd like, we could [automatically choose one for you](#try-zellij-without-installing). + +You can also install (compile) with `cargo`: ``` cargo install --locked zellij ``` -Or if want to a prebuilt binary, you can download it from our [releases](https://github.com/zellij-org/zellij/releases), or use [`cargo-binstall`](https://github.com/ryankurte/cargo-binstall). - -``` -cargo-binstall zellij -``` - -Or you can also use [Third Party Repositories](./docs/THIRD_PARTY_INSTALL.md). - #### Try Zellij without installing bash/zsh: @@ -91,8 +86,6 @@ For configuring Zellij, please see the [Configuration Documentation](https://zel Zellij should be ready for everyday use, but it's still classified as a beta. This means that there might be a rare crash or wrong behaviour here and there, but that once found it should be fixed rather quickly. If this happens to you, we would be very happy if you could open an issue and tell us how to reproduce it as best you can. - - ## Roadmap Presented here is the project roadmap, divided into three main sections. diff --git a/assets/demo.gif b/assets/demo.gif index 8c9ba55e..1adfaa3c 100644 Binary files a/assets/demo.gif and b/assets/demo.gif differ diff --git a/zellij-client/Cargo.toml b/zellij-client/Cargo.toml index f8d6045a..c2f194ff 100644 --- a/zellij-client/Cargo.toml +++ b/zellij-client/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij-client" -version = "0.34.5" +version = "0.35.0" authors = ["Kunal Mohan "] edition = "2021" description = "The client-side library for Zellij" @@ -14,7 +14,7 @@ serde = { version = "1.0", features = ["derive"] } url = { version = "2.2.2", features = ["serde"] } serde_yaml = "0.8" serde_json = "1.0" -zellij-utils = { path = "../zellij-utils/", version = "0.34.5" } +zellij-utils = { path = "../zellij-utils/", version = "0.35.0" } log = "0.4.17" [dev-dependencies] diff --git a/zellij-server/Cargo.toml b/zellij-server/Cargo.toml index 94204890..d451d428 100644 --- a/zellij-server/Cargo.toml +++ b/zellij-server/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij-server" -version = "0.34.5" +version = "0.35.0" authors = ["Kunal Mohan "] edition = "2021" description = "The server-side library for Zellij" @@ -21,7 +21,7 @@ url = "2.2.2" wasmer = "2.3.0" wasmer-wasi = "2.3.0" cassowary = "0.3.0" -zellij-utils = { path = "../zellij-utils/", version = "0.34.5" } +zellij-utils = { path = "../zellij-utils/", version = "0.35.0" } log = "0.4.17" typetag = "0.1.7" chrono = "0.4.19" diff --git a/zellij-tile-utils/Cargo.toml b/zellij-tile-utils/Cargo.toml index 412d6d5e..6d1ecf48 100644 --- a/zellij-tile-utils/Cargo.toml +++ b/zellij-tile-utils/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij-tile-utils" -version = "0.34.5" +version = "0.35.0" authors = ["denis "] edition = "2021" description = "A utility library for Zellij plugins" diff --git a/zellij-tile/Cargo.toml b/zellij-tile/Cargo.toml index 7e36f919..11b6b0ee 100644 --- a/zellij-tile/Cargo.toml +++ b/zellij-tile/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij-tile" -version = "0.34.5" +version = "0.35.0" authors = ["Brooks J Rady "] edition = "2021" description = "A small client-side library for writing Zellij plugins" @@ -12,4 +12,4 @@ serde = { version = "1.0", features = ["derive"] } serde_json = "1.0" strum = "0.20.0" strum_macros = "0.20.0" -zellij-utils = { path = "../zellij-utils/", version = "0.34.5" } +zellij-utils = { path = "../zellij-utils/", version = "0.35.0" } diff --git a/zellij-utils/Cargo.toml b/zellij-utils/Cargo.toml index 76603186..e949c8c6 100644 --- a/zellij-utils/Cargo.toml +++ b/zellij-utils/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zellij-utils" -version = "0.34.5" +version = "0.35.0" authors = ["Kunal Mohan "] edition = "2021" description = "A utility library for Zellij client and server"