v1.0.0 public release

Author: wavim

.npmignore

@@ -2,3 +2,4 @@
 src
 media
 *config.*
+pnpm*.yaml

README.md

@@ -21,6 +21,22 @@ pnpm add neogit
 yarn add neogit
 ```
 
+NeoGit is a pure TS library serving as a readonly, high-performance alternative to isomorphic-git,
+addressing several issues (i.e.
+[incorrect merge-base algorithm](https://github.com/isomorphic-git/isomorphic-git/issues/2109)).
+
+IsoGit caches many things, including entire Git object packs (potentially massive). In contrast,
+NeoGit takes a minimal and deliberate approach to caching. While caching much less data, NeoGit
+still outperforms IsoGit by a factor of 2x in many scenarios.
+
+NeoGit is suitable for environments where native modules are not supported, such as VSCode
+extensions. It provides a lightweight yet performant alternative to NodeGit when cache invalidation
+is not a primary concern.
+
+Developed for [VSCode Git Branch](https://github.com/wavim/vscode-git-branch), this library focuses
+on a core set of Git features and is not a full implementation of all Git capabilities. Therefore
+API is not documented, plus I'm particularly lazy (it should be self-documenting).
+
 ---
 
-_ _
+_Caching whole pack files...?_

package.json

@@ -1,20 +1,23 @@
 {
 "name": "neogit",
 "author": "wavim",
-"version": "0.0.0",
+"version": "1.0.0",
 "description": "Git Isometry for Node.js",
 "lint-staged": {
 "*.ts": [
 "eslint --fix --no-warn-ignored --max-warnings=0",
 "prettier --write"
 ]
 },
-"repository": "github:wavim/neogit",
+"repository": {
+"type": "git",
+"url": "git+https://github.com/wavim/neogit.git"
+},
 "license": "MIT",
 "keywords": [
 "git",
-"iso",
-"node"
+"node",
+"isomorphic"
 ],
 "main": "dist/index.cjs",
 "module": "dist/index.mjs",