From 6b16a2cd672edcbfeaf7988591db92ed4c594ddc Mon Sep 17 00:00:00 2001
From: nsfisis <nsfisis@gmail.com>
Date: Tue, 21 Jul 2026 07:55:40 +0900
Subject: chore: update README

---
 README.md | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c1221033..dd5a313a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,29 @@
 # Shirabe
 
-![placeholder logo](./logo.svg)
+![Shirabe logo](./logo.svg)
 
-Yet another dependency manager for PHP.
+Shirabe is a port of [Composer](https://github.com/composer/composer), the dependency manager for PHP, written in Rust.
 
-*WORK IN PROGRESS*
+It aims at 100% compatibility with Composer, including the plugin API.
+
+*WORK IN PROGRESS*: while full compatibility is the goal, the project is at an early stage and still has many incompatibilities and bugs. See [known incompatibilities](./docs/known-incompatibilities.md) for the differences that will remain intentionally.
+
+
+## Build
+
+```
+$ git submodule update --init
+$ cargo build --release
+```
+
+
+## Test
+
+```
+$ cargo test
+```
 
 
 ## License
 
-See [LICENSE.md](LICENSE.md).
+See [LICENSE.md](./LICENSE.md).
-- 
cgit v1.3.1