updated framework and readme

jacobwi · Nov 3, 2024 · ab1c178 · ab1c178
1 parent c67f574
commit ab1c178
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 109 deletions.
diff --git a/.github/workflows/publisher.yml b/.github/workflows/publisher.yml
@@ -23,6 +23,23 @@ jobs:
         with:
           dotnet-version: 8.0.x
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build assets
+        run: pnpm build
+
       - name: Get Version
         id: version
         shell: bash
@@ -54,23 +71,5 @@ jobs:
         with:
           artifacts: "*.nupkg"
           name: Release ${{ steps.version.outputs.version }}
-          body: |
-            Release of version ${{ steps.version.outputs.version }}
-
-            ### What's Changed
-            - Added MinIO integration for .NET Aspire
-            - Support for custom ports (API and Console)
-            - Configurable credentials
-            - Data volume persistence
-            - S3-compatible endpoint configuration
-            - Connection string support
-
-            ### Getting Started
-            ```csharp
-            var builder = DistributedApplication.CreateBuilder(args);
-            var minio = builder.AddMinIO("storage", options => options
-                .WithPorts(apiPort: 9000, consolePort: 9001)
-                .WithCredentials("accesskey", "secretkey"));
-            ```
           draft: true
           allowUpdates: true
diff --git a/.gitignore b/.gitignore
@@ -616,6 +616,8 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
+.idea/*
+
 ### VisualStudio ###
 
 # User-specific files

diff --git a/Moka.UI.csproj b/Moka.UI.csproj
@@ -54,10 +54,6 @@
             <PackagePath></PackagePath>
         </None>
         <!-- Include the README in the package -->
-        <None Include="../README.md">
-            <Pack>True</Pack>
-            <PackagePath></PackagePath>
-        </None>
     </ItemGroup>
 
     <Target Name="CopyBulmaCss" BeforeTargets="PrepareForBuild">

diff --git a/readme.md b/readme.md
@@ -1,87 +1,67 @@
-name: Publish Package
-on:
-  push:
-    tags:
-      - 'v*'
-
-permissions:
-  contents: write
-  packages: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: 7.0.x  # Changed to .NET 7 as per your requirements
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18'
-
-      - name: Install Dependencies
-        run: yarn install
-
-      - name: Build Assets
-        run: yarn build
-
-      - name: Get Version
-        id: version
-        shell: bash
-        run: |
-          VERSION=${GITHUB_REF#refs/tags/v}
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "version-without-v=$VERSION" >> $GITHUB_OUTPUT
-
-      - name: Pack
-        run: dotnet pack --configuration Release /p:Version=${{ steps.version.outputs.version-without-v }} -p:PackageId=Midmoka.UI --output .
-
-      # Add GitHub Packages source
-      - name: Add GitHub Source
-        run: |
-          dotnet nuget add source --username jacobwi --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/jacobwi/index.json"
-
-      # Push to GitHub Packages
-      - name: Push to GitHub Packages
-        run: |
-          dotnet nuget push *.nupkg --source "github" --api-key ${{ secrets.GITHUB_TOKEN }} --skip-duplicate
-
-      # Push to NuGet.org
-      - name: Push to NuGet
-        run: |
-          dotnet nuget push *.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate
-
-      - name: Create Release
-        uses: ncipollo/release-action@v1
-        with:
-          artifacts: "*.nupkg"
-          name: Release ${{ steps.version.outputs.version }}
-          body: |
-            Release of version ${{ steps.version.outputs.version }}
-
-            ### What's Changed
-            - Blazor components wrapping Bulma CSS framework
-            - Responsive design support
-            - Customizable theming
-            - Interactive components
-            - Font Awesome integration
-
-            ### Getting Started
-            ```html
-            <!-- Add to your _Host.cshtml or index.html -->
-            <link href="_content/Midmoka.UI/css/midmoka.css" rel="stylesheet" />
-            ```
-
-            ```csharp
-            // Add to your Program.cs
-            builder.Services.AddMidmokaUI();
-            ```
-          draft: true
-          allowUpdates: true
+# 🚀 Midmoka.UI - Bulma Blazor Components
+[![NuGet](https://img.shields.io/nuget/v/Moka.Editor.Md.svg)](https://www.nuget.org/packages/Moka.Editor.Md/) [![NuGet](https://img.shields.io/nuget/dt/Moka.Editor.Md.svg)](https://www.nuget.org/packages/Moka.Editor.Md/)
+## Introduction 📖
+Midmoka.UI is a Blazor class library that wraps [Bulma](https://bulma.io/) 🎨, a modern CSS framework, into reusable Blazor components. With Midmoka.UI, you can build responsive 📱 web applications with beautiful components, leveraging both Blazor's powerful C# capabilities 🔥 and Bulma's sleek styling ✨.
+## Features ✨
+- 🎨 **Theming**: Customize components with Bulma variables and your own themes.
+- 🧱 **Reusable Components**: Use out-of-the-box components for faster development.
+- 📱 **Responsive**: Build websites that look great on all devices.
+- 🔧 **Customizable**: Adjust components with a wide range of parameters and options.
+- 🎉 **Interactive Demos**: See components in action with live examples.
+## Getting Started
+### Prerequisites
+Ensure you have the following installed:
+- .NET 7.0+
+- Node.js
+- Yarn/Node package manager
+### Installation
+1. Install the necessary Node.js packages:
+```bash
+yarn
+```
+2. Run the Gulp tasks to bundle and prepare your assets:
+```bash
+yarn build
+```
+3. Build the library:
+```bash
+dotnet build
+```
+### Usage
+After installing the package and running Gulp tasks, simply reference the bundled files in your header tag in index HTML
+file.
+For CSS:
+```html
+<link href="_content/Moka.UI/css/midmoka.css" rel="stylesheet" />
+```
+### 🍷 Gulp Tasks
+I use Gulp to automate the bundling and optimization of assets. Here's what each task does:
+- styles: Concatenates and minifies CSS files and includes Font Awesome styles.
+- default: Runs all the above tasks in sequence.
+  You can run a specific task with the following command:
+```
+yarn gulp <task-name>
+```
+For example, to only run the styles task:
+```bash
+yarn gulp styles
+```
+### 🫂 Contributing
+Contributions are welcome as this is an open-source project in such an amazing place to learn, inspire, and create. Any
+contributions you make are greatly appreciated.
+#### 🪜 Steps:
+- Fork the Project
+- Create your Feature Branch (git checkout -b feature/AmazingFeature)
+- Commit your Changes (git commit -m 'Add some AmazingFeature')
+- Push to the Branch (git push origin feature/AmazingFeature)
+- Open a Pull Request
+### License
+Distributed under the MIT License. See LICENSE for more information.
+🫡 Jacob William - me@jacobwi.net
+### WIP
+- [x] Add Bulma
+- [ ] Upload to NuGet
+- [ ] Add more tests
+- [ ] Add more documentation
+- [ ] Add more examples
+- [ ] Add more features