cover page

steinybot · Nov 25, 2023 · 3a18f47 · 3a18f47
1 parent 13ad031
commit 3a18f47
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
 ![kyo](https://raw.githubusercontent.com/getkyo/kyo/master/kyo.png)
 ----------
 
+## Please visit [getkyo.io](https://getkyo.io/) for an indexed version of this documentation.
+
+## Introduction
+
 ![Build Status](https://github.com/getkyo/kyo/workflows/build/badge.svg)
 ![Chat](https://img.shields.io/discord/1087005439859904574)
-<!---![Version](https://img.shields.io/maven-central/v/io.getkyo/kyo-core_3)--->
+![Version](https://img.shields.io/maven-central/v/io.getkyo/kyo-core_3)
 
 Kyo is a complete toolkit for Scala development, spanning from browser-based apps in ScalaJS to high-performance backends on the JVM. It introduces a novel approach based on algebraic effects to deliver straightforward APIs in the pure Functional Programming paradigm. Unlike similar solutions, Kyo achieves this without inundating developers with esoteric concepts from Category Theory or using cryptic symbolic operators, resulting in a development experience that is both intuitive and robust.
 
 Drawing inspiration from [ZIO](https://zio.dev/)'s [effect rotation](https://degoes.net/articles/rotating-effects), Kyo takes a more generalized approach. While ZIO restricts effects to two channels, dependency injection and short-circuiting, Kyo allows for an arbitrary number of effectful channels. This enhancement gives developers greater flexibility in effect management, while also simplifying Kyo's internal codebase through more principled design patterns.
 
-## Please visit [getkyo.io](https://getkyo.io/) for an indexed version of this documentation.
-
-## Introduction
-
 ### The `>` type
 
 In Kyo, computations are expressed via the infix type `>`, which takes two parameters:

diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,13 @@
+![logo](https://github.com/getkyo/kyo/blob/main/kyo.png?raw=true)
+
+> Toolkit for Scala Development
+
+- Streamlined Algebraic Effects
+- Simplified Functional Programming
+- Peak Scala Performance
+
+[GitHub](https://github.com/getkyo/kyo/)
+[Get Started](#introduction)
+
+<!-- background color -->
+![color](#dff0f7)
diff --git a/docs/index.html b/docs/index.html
@@ -15,6 +15,7 @@
       name: '',
       repo: 'getkyo/kyo',
       homepage: 'https://raw.githubusercontent.com/getkyo/kyo/main/README.md',
+      coverpage: true,
       plugins: [
         function (hook, vm) {
           hook.beforeEach(function (content) {