Skip to content

Commit

Permalink
docs(readme): Update docs (#184)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseLion authored Jan 12, 2023
1 parent 803c769 commit e3cd2f2
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/owner-approve.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ jobs:
if: github.actor == github.repository_owner
runs-on: ubuntu-latest
steps:
- uses: hmarr/auto-approve-action@v2.0.0
- uses: hmarr/auto-approve-action@v3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
21 changes: 15 additions & 6 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---

name: Pages

on:
push:
branches: ["release"]
branches: [release]

permissions:
contents: read
Expand All @@ -19,13 +20,19 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/configure-pages@v1
- uses: actions/jekyll-build-pages@v1
- name: Checkout
uses: actions/checkout@v3

- name: Setup Pages
uses: actions/configure-pages@v2

- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ./_site
- uses: actions/upload-pages-artifact@v1
- name: Upload artifact
uses: actions/upload-pages-artifact@v1

deploy:
environment:
Expand All @@ -35,4 +42,6 @@ jobs:
needs: build

steps:
- uses: actions/deploy-pages@v1
- uses: actions/deploy-pages@v1

...
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[![Maven Central](https://img.shields.io/maven-central/v/io.github.joselion/maybe.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.joselion%22%20AND%20a:%22maybe%22)
[![javadoc](https://javadoc.io/badge2/io.github.joselion/maybe/javadoc.svg)](https://javadoc.io/doc/io.github.joselion/maybe)
[![codecov](https://codecov.io/gh/JoseLion/maybe/branch/main/graph/badge.svg)](https://codecov.io/gh/JoseLion/maybe)
[![License](https://img.shields.io/github/license/JoseLion/maybe)](./LICENSE)
[![Snyk Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/JoseLion/maybe)](https://snyk.io/)

# Maybe - Safely handle exceptions

Expand All @@ -17,6 +19,10 @@ The wrapper intends to help us avoid the imperative _try/catch_ syntax, while pr
* Includes an entirely safe `Either<L, R>` type where only one side can be present at a time
* Method reference friendly - The API provides methods with overloads that makes it easier to use [method reference](https://docs.oracle.com/javase/tutorial/java/javaOO/methodreferences.html) syntax.

## Presentation

- [JCon 2021 - Handling exception, the functional way](https://youtu.be/vaRjOukcIDA)

## Requirements

As of v3 this library uses new Java features, so `Java 18+` is required. This library moves along with Java and the requirement might increase as new Java versions aare released.
Expand Down
51 changes: 49 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,53 @@
remote_theme: mmistakes/minimal-mistakes
---

minimal_mistakes_skin: dark
remote_theme: mmistakes/minimal-mistakes

plugins:
- jekyll-include-cache
- jekyll-github-metadata

defaults:
- scope:
path: ""
type: pages
values:
author_profile: true
classes: wide
layout: single

minimal_mistakes_skin: dark
title: Maybe
subtitle: A monadic wrapper with a type-safe API to handle throwing operations in a functional way
name: Jose Luis Leon
repository: JoseLion/maybe
atom_feed:
hide: true
twitter:
username: joseliont
author:
name: Jose Luis Leon
avatar: https://github.com/JoseLion.png
email: [email protected]
links:
- label: Repository
icon: fab fa-fw fa-github
url: https://github.com/JoseLion/maybe
- label: GitHub
icon: fab fa-fw fa-github-alt
url: https://github.com/JoseLion
- label: Twitter
icon: fab fa-fw fa-twitter-square
url: https://twitter.com/joseliont
footer:
links:
- label: Repository
icon: fab fa-fw fa-github
url: https://github.com/JoseLion/maybe
- label: GitHub
icon: fab fa-fw fa-github-alt
url: https://github.com/JoseLion
- label: Twitter
icon: fab fa-fw fa-twitter-square
url: https://twitter.com/joseliont

...

0 comments on commit e3cd2f2

Please sign in to comment.