From 13c09b1e353c1a3f7029b502eaa98cadfccc327c Mon Sep 17 00:00:00 2001 From: Yanick Fratantonio Date: Wed, 20 Nov 2024 15:17:00 +0100 Subject: [PATCH] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a38c9739..9b07f7de 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ For more context you can read our initial [announcement post on Google's OSS blo > [!IMPORTANT] > We are about to release a number of new things, and they are ready for testing! -> - We uploaded to pypi [`magika 0.6.0rc3`](https://pypi.org/project/magika/0.6.0rc3/), it's ready for testing! Please report any problems here: https://github.com/google/magika/issues/798. +> - We uploaded to pypi a release candidate for v0.6.0 (e.g., [`magika 0.6.0rc3`](https://pypi.org/project/magika/0.6.0rc3/)), it's ready for testing! Please report any problems here: https://github.com/google/magika/issues/798. You can install the latest release candidate with `pip install --pre magika`. > - A new ML model with support for [200+ content types](./assets/models/standard_v2_1/README.md). > - A new CLI written in Rust. This will replace the previous CLI written in python. More information [here](./rust/cli/README.md). The Rust codebase can also be used for applications written in rust, see the [docs](https://docs.rs/magika/0.1.0-rc.1/magika/index.html). -> - Python package 0.6.0rc3: this version ships the new model with support for 200+ content types, the CLI written in Rust (which replaces the old one written in python), and a revamped Python API with a few breaking changes, see the [docs](./python/README.md) and the [changelog](./python/CHANGELOG.md)! +> - Upcoming python package v0.6.0: this version ships the new model with support for 200+ content types, the CLI written in Rust (which replaces the old one written in python), and a revamped Python API with a few breaking changes, see the [docs](./python/README.md) and the [changelog](./python/CHANGELOG.md)! > - If you need docs about the stable release, browse this repository at the latest stable tag, [here](https://github.com/google/magika/tree/python-v0.5.1). > - The Magika paper was accepted at IEEE/ACM International Conference on Software Engineering (ICSE) 2025! Stay tuned! @@ -50,7 +50,7 @@ For more details, see the documentation for the [python package](./python/README 1. [Installation](#installation) 1. [Running on Docker](#running-in-docker) 1. [Usage](#usage) - 1. [Python command line](#python-command-line) + 1. [Command line (written in Rust)](#command-line-written-in-rust) 1. [Python API](#python-api) 1. [Experimental TFJS model & npm package](#experimental-tfjs-model--npm-package) 1. [Development Setup](#development-setup) @@ -75,6 +75,9 @@ $ pip install magika If you intend to use Magika only as a command line, you may want to use `$ pipx install magika` instead. +If you want to test out the latest release candidate, you can install with `pip install --pre magika`. + + ### Running in Docker ```