Skip to content

Commit

Permalink
updated README.md and semver
Browse files Browse the repository at this point in the history
  • Loading branch information
Anusikh Panda committed Mar 8, 2024
1 parent 23f0b0d commit c8897c9
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "jvem"
version = "0.1.0"
version = "0.2.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
45 changes: 29 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,82 @@
# Java Version Manager (JVeM)

![JVeM](/public/final-logo-black.png)

Java Version Manager (JVeM) is a cross-platform tool designed to simplify the management of multiple Java versions on your system. Whether you're a developer working on diverse projects or an enthusiast exploring different Java applications, JVeM makes it easy to switch between and manage various Java versions seamlessly.

## Table of Contents

1. [Features](#features)
2. [Supported Platforms](#supported-platforms)
3. [Getting Started](#getting-started)
- [Windows Installation](#windows-installation)
- [macOS Installation](#macos-installation)
- [Linux Installation](#linux-installation)
- [Windows Installation](#windows-installation)
- [macOS Installation](#macos-installation)
- [Linux Installation](#linux-installation)
4. [Usage](#usage)
- [Commands and Descriptions](#commands-and-descriptions)
- [Commands and Descriptions](#commands-and-descriptions)
5. [Future Scope](#future-scope)

## Features:

- **Cross-Platform Support:** JVeM is compatible with macOS, Linux, and Windows, providing a consistent experience across different operating systems.
- **Simple Version Switching:** Easily switch between different Java versions with a single command, streamlining your development workflow.
- **Effortless Installation:** JVeM offers a straightforward installation process on supported platforms, ensuring quick setup without unnecessary complications.
- **Customizable Configuration:** Tailor JVeM to your specific needs by configuring environment variables and settings to suit your Java development environment.

## Supported Platforms:

- Windows
- Linux
- macOS

## Getting Started:

To get started with JVeM, refer to the installation instructions and basic usage guidelines below.

#### Windows Installation

- Download the latest `jvem.zip` file from [Releases](https://github.com/anusikh/jvem/releases)
- Extract this file here.
- Add this path to your environment variables: `C:\Users\<user>\.jvem\java\bin`
- Add the path of the extracted folder to environment variables.

#### macOS Installation

- Download the latest `jvem_macos.tar.gz` file from [Releases](https://github.com/anusikh/jvem/releases)
- Extract the tarball file.
- Add this line to your zshrc/bashrc file: `export JAVA_HOME=$HOME/.jvem/java` and source it.
- Add an alias to use jvem easily. `alias jvem=~/Downloads/jvem`

#### Linux Installation

- Download the latest `jvem_linux.tar.gz` file from [Releases](https://github.com/anusikh/jvem/releases)
- Extract the tarball file.
- Add this line to your zshrc/bashrc file: `PATH=$PATH:$HOME/.jvem/java/bin` and source it.
- Add an alias to use jvem easily. `alias jvem=~/Downloads/jvem`

## Usage:

Once installed, use the following commands to manage your Java versions.

#### Commands and Descriptions
| Command | Description |
|-----------------------------------|-----------------------------------------------|
| `jvem lsrem` | List all JDK versions available for install. |
| `jvem ls` | List locally installed JDK versions. |
| `jvem install zulu21` | Install Zulu JDK version 21. |
| `jvem usev zulu17` | Use a specific JDK version after installation.|
| `jvem current` | Find the currently active JDK version. |
| `jvem deactivate` | Deactivate the currently active JDK. |
| `jvem uninstall zulu17` | Uninstall the specified JDK version. |
| `jvem help` | Display help information. |
| `jvem clean` | Clean empty folders in the .jvem directory. |
| `jvem --V` or `jvem --version` | Display the version of JVeM. |

| Command | Description |
| ------------------------------ | ---------------------------------------------- |
| `jvem lsrem` | List all JDK versions available for install. |
| `jvem ls` | List locally installed JDK versions. |
| `jvem install zulu21` | Install Zulu JDK version 21. |
| `jvem usev zulu17` | Use a specific JDK version after installation. |
| `jvem current` | Find the currently active JDK version. |
| `jvem deactivate` | Deactivate the currently active JDK. |
| `jvem uninstall zulu17` | Uninstall the specified JDK version. |
| `jvem help` | Display help information. |
| `jvem clean` | Clean empty folders in the .jvem directory. |
| `jvem --V` or `jvem --version` | Display the version of JVeM. |

## Future Scope:

JVeM is an evolving project, and future updates may include:

- Addition of more JDKs
- Addition of support for new platforms.
- Integration of test cases to enhance stability.
Expand Down
Binary file added public/final-logo-black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c8897c9

Please sign in to comment.