Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sake92 committed Aug 28, 2023
1 parent 8c2eb45 commit 1e91bac
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 14 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
branches:
- main
tags: ["*"]
workflow_run:
workflows: ["CI"]
types:
- completed
jobs:
publish:
if: github.repository == 'sake92/sharaf'
if: github.repository == 'sake92/sharaf' && github.event.workflow_run.conclusion == 'success'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
Expand Down
2 changes: 1 addition & 1 deletion .mill-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.11.1
0.11.2
2 changes: 1 addition & 1 deletion DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ git push origin $VERSION

# TODOs

- cookies
- cookies ?
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@

# Sharaf


## Misc

Why name "sharaf"?

Šaraf means a "screw" in Bosnian, and it reminds me of scala spiral logo.

---

## Why sharaf?

**Simplicity and ease of use** is the main focus of sharaf.

It is built on top of [undertow](https://undertow.io/).
This means you can use some awesome libraries built for undertow, like [pac4j](https://github.com/pac4j/undertow-pac4j) for security and similar.
Also, you can use undertow's lower level API, to implement WebSocket for example.
Also, you can use undertow's lower level API, to use WebSockets for example.

Sharaf bundles a set of libraries:
- [querson](./querson) for query parameters
- [hepek-components](https://github.com/sake92/hepek) for HTML (with [scalatags](https://github.com/com-lihaoyi/scalatags))
- [tupson](https://github.com/sake92/tupson) for JSON
- [formson](./formson) for forms
- [validson](./formson) for validation
- [hepek-components](https://github.com/sake92/hepek) for HTML (with [scalatags](https://github.com/com-lihaoyi/scalatags))

There are a bunch of [examples](./examples) to get you started.

## Misc

Why name "sharaf"?

Šaraf means a "screw" in Bosnian, which reminds me of scala spiral logo.
2 changes: 2 additions & 0 deletions sharaf/test/src/ba/sake/sharaf/routing/PathTest.scala
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import java.util.UUID
class PathTest extends munit.FunSuite {

test("path matching") {
if true then
throw RuntimeException("test")
val uuidValue = UUID.randomUUID
val paths = Seq(
Path("users", "1"),
Expand Down

0 comments on commit 1e91bac

Please sign in to comment.