chore: update README and package.json for release

Author: blyedev

README.md

@@ -1,2 +1,90 @@
-# postcss-angular-inline
-PostCSS syntax for parsing inline CSS of Angular components
+# PostCSS Angular Inline
+
+## Overview
+
+A [PostCSS](https://github.com/postcss/postcss) syntax plugin to process inline CSS styles in Angular components, enabling the use of PostCSS transformations and Stylelint.
+
+**Current Version:** `0.1.0`
+
+## Usage with PostCSS
+
+1. Install via npm:
+
+   ```bash
+   npm install --save-dev postcss-angular-inline
+   ```
+
+2. Configure PostCSS:
+
+   ```javascript
+   // postcss.config.js
+   module.exports = {
+     syntax: "postcss-angular-inline",
+     plugins: [
+       // Your PostCSS plugins
+     ],
+   };
+   ```
+
+## Usage with Stylelint
+
+To use Stylelint with this syntax plugin and confine linting to only .component.ts files, follow these steps:
+
+1. Install Stylelint and Necessary Plugins
+
+   ```bash
+   npm install --save-dev stylelint stylelint-config-standard postcss-angular-inline
+   ```
+
+2. Create a .stylelintrc.json Configuration File
+
+   ```json
+   // .stylelintrc.json
+   {
+     "extends": ["stylelint-config-standard"],
+     "overrides": [
+       {
+         "files": ["**/*.component.ts"],
+         "customSyntax": "postcss-angular-inline",
+         "rules": {
+           // Your Stylelint rules
+         },
+       },
+     ],
+   };
+   ```
+
+3. Run Stylelint on .component.ts Files
+
+   ```bash
+   npx stylelint "**/*.component.ts"
+   ```
+
+## Roadmap to Version 1.0.0
+
+The following features and improvements are planned before the official 1.0.0 release:
+
+1. Better Typing (Target Version: 0.2.0)
+
+   - Improve TypeScript definitions for enhanced developer experience and code safety.
+
+2. Testing (Target Version: 0.3.0)
+
+   - Enhance the test suite to ensure reliability and prevent regressions.
+
+3. Support for Preprocessors (Target Version: 0.4.0)
+
+   - Add support for SCSS and LESS inline styles in Angular components.
+
+4. Handling Empty Strings (Target Version: 0.5.0)
+
+   - Fix issues where empty inline styles are not correctly recognized or processed.
+
+5. Preserving Escaped Newlines (Target Version: 0.6.0)
+   - Ensure escaped newlines `\n` in strings are preserved and correctly represented in the output.
+
+## Current Limitations
+
+- Escaped newlines (\n) are not preserved, affecting tools like Stylelint.
+- Empty sources may not be handled correctly by Stylelint.
+- Does not support SCSS or LESS in inline styles.

package-lock.json

@@ -1,8 +1,25 @@
 {
   "name": "postcss-angular-inline",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "description": "PostCSS syntax for parsing inline CSS of Angular components",
+  "keywords": [
+    "postcss",
+    "angular",
+    "inline-styles",
+    "css",
+    "syntax",
+    "stylelint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blyedev/postcss-angular-inline.git"
+  },
   "main": "src/index.js",
+  "files": [
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
   "author": "blyedev",
   "license": "ISC",
   "type": "module",

package.json

@@ -15,6 +15,7 @@ const dirPath = join(__dirname, "fixtures");
 
 /**
  * Retrieves a test case
+ *
  * @param {string} filename Path of fixture
  * @returns {Fixture} Retrieved fixture
  */
@@ -26,6 +27,7 @@ export function getFixtureCode(filename) {
 
 /**
  * Get all availible fixture paths
+ *
  * @returns {string[]} All available fixture filenames
  */
 export function getAllFixtureFilenames() {