feat: workflow to commit dist folder for release (#9)

Author: Emmanuel-Develops

.gitattributes

@@ -0,0 +1 @@
+dist/** linguist-generated=true

.github/workflows/build-and-release.yml

@@ -0,0 +1,39 @@
+name: Build and Release
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  build-and-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build project
+        run: yarn build
+
+      - name: Commit dist folder
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add dist
+          git commit -m "Build dist folder for release ${{ github.ref }}" || echo "No changes to commit"
+          git push
+
+      - name: Update release with dist folder
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload ${{ github.ref }} dist/** --clobber

.gitignore

@@ -10,7 +10,6 @@
 
 # production
 /build
-/dist
 src/styles/tailwind.output.css
 
 # Storybook

README.md

@@ -2,6 +2,58 @@
 
 **An open-source UI component library for the Bitcoin Dev Project (BDP) Apps**
 
+## Installation
+
+To install the BDP-UI library, you can use the following command:
+
+```bash
+yarn add github:bitcoin-dev-project/bdp-ui 
+```
+or 
+```bash
+npm install github:bitcoin-dev-project/bdp-ui
+```
+
+## Usage
+
+Once installed, you can import the components you need from the library:
+
+note: you can set up an entry point in your project config to `/dist` to fix the autocomplete and linting issues. Or in typescript you can use the `paths` property in tsconfig.json to fix the import paths.
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "bdp-ui/*": ["./node_modules/bdp-ui/dist/*"]
+    }
+  }
+}
+```
+
+### Components
+
+```jsx
+import { Button } from 'bdp-ui';
+
+function App() {
+  return (
+    <Button>Hello, World!</Button>
+  );
+}
+```
+
+### Icons
+```jsx
+import { GithubIcon } from 'bdp-ui/icons';
+
+function App() {
+  return (
+    <GithubIcon className="w-[40px] text-black" />
+  );
+}
+```
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details