feat(docs): add readme.md & LICENSE

sajiljosephs · Oct 12, 2020 · 8eef122 · 8eef122
1 parent c82e6ce
commit 8eef122
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -13,32 +13,40 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      # Web site
+      - name: Add some files
+        run: |
+          echo "akhq.io" > docs/CNAME
+          cp LICENSE docs/LICENSE
+          cp README.md docs/README.md
+          cp README.md docs/README
+          cp artifacthub-repo.yml docs/artifacthub-repo.yml
+
       # Helm charts
       - uses: J12934/helm-gh-pages-action@master
         with:
           access-token: ${{ secrets.GITHUB_PERSONAL_TOKEN }}
           charts-folder: "helm"
           deploy-branch: helm
 
-      # Web site
-      - name: Contributor
-        run: |
-          npm i github-contributors-list
-          node_modules/.bin/githubcontrib --repo akhq --owner tchiotludo --format html --sortOrder desc > docs/contributors.html
-
       # Clone helm charts
       - name: Clone helm charts
         uses: actions/checkout@v2
         with:
           ref: helm
           path: tmp-helm
 
-      # Web site
+      # Add helm charts
       - name: Add helm charts
         run: |
           rm -rf tmp-helm/.git
           cp -R tmp-helm/* docs/
-          echo "akhq.io" > docs/CNAME
+
+      # Contributors
+      - name: Contributor
+        run: |
+          npm i github-contributors-list
+          node_modules/.bin/githubcontrib --repo akhq --owner tchiotludo --format html --sortOrder desc > docs/contributors.html
 
       # Deploy
       - name: Deploy

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 ![Github Downloads](https://img.shields.io/github/downloads/tchiotludo/akhq/total)
 ![Github Start](https://img.shields.io/github/stars/tchiotludo/akhq.svg)
 ![Main](https://github.com/tchiotludo/akhq/workflows/Main/badge.svg)
+[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/akhq)](https://artifacthub.io/packages/search?repo=akhq)
 
 > Kafka GUI for [Apache Kafka](http://kafka.apache.org/) to manage topics, topics data, consumers group, schema registry, connect and more...
 

diff --git a/artifacthub-repo.yml b/artifacthub-repo.yml
@@ -0,0 +1 @@
+repositoryID: 4ff0915c-0d71-4f9b-9440-2038c81039f9
diff --git a/helm/akhq/Chart.yaml b/helm/akhq/Chart.yaml
@@ -7,6 +7,8 @@ keywords:
   - kafka
   - confluent
   - gui
+  - schema-registry
+  - kafka-connect
 home: https://akhq.io
 icon: https://raw.githubusercontent.com/tchiotludo/akhq/master/assets/img/logo_black.png
 sources:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		repositoryID: 4ff0915c-0d71-4f9b-9440-2038c81039f9