chore: Update readme

Author: randy3k

CHANGELOG.md

@@ -1,9 +1,20 @@
-# Change Log
+# Changelog
 
-All notable changes to the "r" extension will be documented in this file.
+All notable changes to this project will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+## [unreleased]
 
-## [Unreleased]
+### ⚙️ Miscellaneous Tasks
 
-- Initial release
+- Add R logo
+- Swtich to npm ci
+- Update readme
+
+## [0.1.0] - 2025-05-13
+
+### ⚙️ Miscellaneous Tasks
+
+- Add github action script
+- Add publish action
+
+<!-- generated by git-cliff -->

README.md

@@ -1,6 +1,32 @@
 # R Syntax Highlight
 
-This Visual Studio Code extension provides syntax highlighting for the R programming language.
+This Visual Studio Code extension provides syntax highlighting for R and R Markdown extensions.
 
 It brings more consistency with other VS Code language syntaxes (such as Python and C) and
 Sublime Text [R syntax](https://github.com/sublimehq/Packages/tree/master/R).
+
+It only contains syntax definitions to allow users to switch to alternative formatters and language servers such as [air](https://github.com/posit-dev/air) and [ark](https://github.com/posit-dev/ark).
+
+## Installation
+
+The releases are available in VSCode Marketplace or Open VSX Registry. Search for extension "R Syntax".
+
+## Contribution
+
+If you are interesting in contributing to the syntaxes, feel free to clone the repository and edit the `r.yaml` and `rmd.yaml` files under the `syntaxes` directroy.
+In order to build the json files, you will need to install node.js and run
+
+```sh
+npm install
+npm run build
+# or the following if you want to build the json files in watch mode
+npm run build -- --watch
+```
+
+You should also run the grammar tests located in the `tests/testdata`. See [vscode-tmgrammar-test](https://github.com/PanAeon/vscode-tmgrammar-test) for details.
+
+```sh
+npm run test:grammar
+# or the following if you want to test in watch mode
+npm run test:grammar -- --watch
+```

package-lock.json

@@ -2,7 +2,7 @@
   "name": "r-syntax",
   "displayName": "R Syntax",
   "description": "R Synxtax Highlight for Visual Studio Code",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "REditorSupport",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -126,11 +126,10 @@
   },
   "scripts": {
     "vscode:prepublish": "npm run build",
+    "changelog": "npx git-cliff -o",
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
     "test:grammar": "node ./scripts/tmgrammar-test.js 'tests/testdata/*.R' 'tests/testdata/*.Rmd'",
-    "test:grammar-watch": "node ./scripts/tmgrammar-test.js --watch 'tests/testdata/*.R' 'tests/testdata/*.Rmd'",
     "build": "node ./scripts/build.js",
-    "build-watch": "node ./scripts/build.js --watch",
     "postinstall": "patch-package",
     "package": "npm run build && vsce package",
     "publish": "npm run build && vsce publish",
@@ -140,6 +139,7 @@
     "@vscode/vsce": "^3.3.2",
     "chokidar": "^4.0.3",
     "cross-env": "^7.0.3",
+    "git-cliff": "^2.8.0",
     "jest": "^29.7.0",
     "js-yaml": "^4.1.0",
     "patch-package": "^8.0.0",