From 13455f0d453967700e687c845456929376871545 Mon Sep 17 00:00:00 2001 From: Tony Bark Date: Wed, 30 Apr 2025 06:48:51 -0400 Subject: [PATCH] Why This Exists and Example sections --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index e8849cc..ba61368 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solution to package management. +💡 Why This Exists + +S2PK was created to address the need for a reliable and efficient cross-platform package management system for The Sims 2 on Linux and macOS. Players on these platforms often face challenges in managing mods due to the lack of a unified solution that their Windows counterparts solved a long time ago. + ## 🛣️ Project Roadmap | Phase | Goal | Status | @@ -17,6 +21,16 @@ S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solutio - System.CommandLine for CLI parsing (no external libraries) - Pure backend logic (no UI planned) +## Example + +```shell +s2pkg pack -s ./mods -o output.s2pk +``` + +``` +s2pkg unpack -p ./output.s2pk -d "%USERPROFILE%\Documents\EA Games\The Sims 2\Downloads" +``` + ## 🗓️ Update Cycle | Type | Frequency | Notes |