readme, packageing changes

Author: abose

.gitignore

@@ -10,3 +10,4 @@ dist/*
 !dist/virtualfs.js.map
 !dist/phoenix-fs.js
 test/dist/
+phcode-language-support-1.0.0.tgz

README.md

@@ -75,3 +75,54 @@ Inorder to publish the package to npm, do the following
 1. run `npm run relese` and push changes to main branch.
 2. raise a pull request from `main` branch to `npm` branch. Once the pull request is merged
 and the code pushed to npm branch, GitHub actions will automatically publish the library to npm.
+
+## API
+
+Below is a markdown documentation for the `CSSLanguageService` object, detailing its functions and usage. This can be used as part of a project's documentation, README, or developer guide.
+
+---
+
+## CSSLanguageService API
+
+The `CSSLanguageService` provides utility functions for parsing CSS and
+retrieving CSS selectors(document symbols such as classes, IDs, and other selectors) from given text content.
+
+### Methods
+
+#### `getAllSymbols(text, cssMode, filePath)`
+
+Retrieves all CSS selectors from the provided CSS text as an array of strings.
+
+**Parameters**:
+
+- `text` (`string`): The CSS code to analyze.
+- `cssMode` (`string`): The mode of the CSS document. This should correspond to one of the supported CSS modes (e.g., CSS, SCSS, LESS) defined in `CSS_MODES`.
+- `filePath` (`string`): Optional. The path of the CSS file, used for resolving relative URLs within the CSS. Defaults to `"file://placeholder.css"`.
+
+**Returns**:
+
+- `Array[string]`: An array containing all the CSS selectors found in the document.
+
+**Example Usage**:
+
+```javascript
+const cssText = ".class { color: red; } #id { margin: 10px; }";
+const selectors = CSSLanguageService.getAllSymbols(cssText, CSSLanguageService.CSS_MODES.CSS);
+console.log(selectors); // Output: [".class", "#id"]
+```
+
+### Constants
+
+#### `CSSLanguageService.CSS_MODES`
+
+Defines the supported CSS modes for the `getAllSymbols` function. Includes:
+
+- `CSS`: Standard CSS.
+- `SCSS`: Sassy CSS (SCSS).
+- `LESS`: Leaner Style Sheets (LESS).
+
+**Example**:
+
+```javascript
+console.log(CSSLanguageService.CSS_MODES.CSS); // Output: "CSS"
+```

package.json

@@ -30,7 +30,8 @@
     "url": "https://github.com/phcode-dev/language-support"
   },
   "files": [
-    "dist/virtualfs.js"
+    "dist/language-worker.js",
+    "dist/language-worker-debug.js"
   ],
   "devDependencies": {
     "vscode-css-languageservice": "^6.0.0",