Skip to content

Commit 9726cce

Browse files
committed
Release 0.1.0
1 parent 4284033 commit 9726cce

File tree

4 files changed

+37
-14
lines changed

4 files changed

+37
-14
lines changed

README.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,37 @@
44
[![Build Status](https://travis-ci.org/outr/youi.svg?branch=master)](https://travis-ci.org/outr/youi)
55
[![Stories in Ready](https://badge.waffle.io/outr/youi.png?label=ready&title=Ready)](https://waffle.io/outr/youi)
66
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/outr/youi)
7-
[![Maven Central](https://img.shields.io/maven-central/v/io.youi/youi-core_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/io.youi/youi-core_2.11)
7+
[![Maven Central](https://img.shields.io/maven-central/v/io.youi/youi-core_2.12.svg)](https://maven-badges.herokuapp.com/maven-central/io.youi/youi-core_2.12)
88
[![Latest version](https://index.scala-lang.org/io.youi/youi/youi-core/latest.svg)](https://index.scala-lang.org/io.youi/youi/youi-core)
99

1010
Next generation user interface and application development in Scala and Scala.js for web, mobile, and desktop.
1111

12-
### Status
12+
## Status
1313

1414
At the moment we are currently migrating hyperscala (https://github.com/outr/hyperscala) and NextUI (https://github.com/outr/nextui)
1515
into this new framework. If you need a production-ready framework please look at those for now.
1616

17-
### Features for 1.0
17+
## Modules
18+
19+
* [core](core) - core features generally useful for web and HTTP (Scala and Scala.js)
20+
* [communicate](communicate) - communication framework to provide type-safe communication between a client / server (Scala and Scala.js)
21+
* [dom](dom) - features and functionality related to working with the browser's DOM (Scala.js)
22+
* [server](server) - base functionality for a web server (Scala)
23+
* [server-undertow](serverUndertow) - implementation of [server](server) using [Undertow](http://undertow.io/) (Scala)
24+
* [ui](ui) - functionality for user-interface creation and management (Scala.js)
25+
26+
## Features for 1.0.0 (In-Progress)
27+
28+
* [ ] User Interface framework for Scala.js (see NextUI)
29+
* [ ] Client / Server Page and Screen support (see Hyperscala)
30+
* [ ] Ajax Request / Response framework for Server (JVM) and Client (JS) (see Hyperscala)
31+
* [ ] Scala JVM and JS Content Modification Streams for any XML / HTML content (see Hyperscala)
32+
33+
## Features for 0.1.0 (Released 2016.12.22)
1834

1935
* [X] Scala JVM and JS support
2036
* [X] URL implementation offering good parsing and flexibility
37+
* [X] URL interpolation at compile-time
2138
* [X] Server abstraction with HttpRequest and HttpResponse allowing for multiple implementations
2239
* [X] HttpHandler prioritization and flow to allow handlers to build upon each other
2340
* [X] IPv4 and IPv6 wrapper classes
@@ -29,7 +46,3 @@ into this new framework. If you need a production-ready framework please look at
2946
* [X] Proxying support and optional ProxyingSupport trait to be mixed into Server
3047
* [X] Session support
3148
* [X] Communication implementation supporting client and server with JVM and JS support (see Hyperscala)
32-
* [ ] User Interface framework for Scala.js (see NextUI)
33-
* [ ] Client / Server Page and Screen support (see Hyperscala)
34-
* [ ] Ajax Request / Response framework for Server (JVM) and Client (JS) (see Hyperscala)
35-
* [ ] Scala JVM and JS Content Modification Streams for any XML / HTML content (see Hyperscala)

build.sbt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name := "youi"
22
organization in ThisBuild := "io.youi"
3-
version in ThisBuild := "0.1.0-SNAPSHOT"
3+
version in ThisBuild := "0.1.0"
44
scalaVersion in ThisBuild := "2.12.1"
55
crossScalaVersions in ThisBuild := List("2.12.1", "2.11.8")
66
sbtVersion in ThisBuild := "0.13.13"

core/README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,44 @@
11
# youi-core
22

3-
## URL
3+
## SBT Configuration
4+
5+
youi is published to Sonatype OSS and Maven Central and utilizes JVM and Scala.js with 2.11 and 2.12:
6+
7+
```
8+
libraryDependencies += "io.youi" %%% "youi-core" % "0.1.0" // Scala and Scala.js
9+
```
10+
11+
## Main Features
12+
13+
### URL
414

515
A fairly simple, but complete representation of a URL. Includes proper parsing, formatting, and manipulation
616
functionality. Finally, URL interpolation at compile-time offers a convenient mechanism to validate URLs at
717
compile-time.
818

919
Creating a URL can be done in various ways.
1020

11-
### Parsing
21+
#### Parsing
1222

1323
```
1424
val url = URL("http://youi.io")
1525
```
1626

17-
### Interpolation
27+
#### Interpolation
1828

1929
Has the benefit of throwing a compilation error if it fails to validate.
2030

2131
```
2232
val url = url"http://youi.io"
2333
```
2434

25-
### Manually
35+
#### Manually
2636

2737
```
2838
val url = URL(protocol = Protocol.Http, host = "youi.io")
2939
```
3040

31-
## Unique
41+
### Unique
3242

3343
Generates a unique String. Similar concept to UUID, but much faster, slightly less unique, and configurable. Uses
3444
`ThreadLocalRandom` to generate the values.

sonatype.sbt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sonatypeProfileName := "com.outr"
1+
sonatypeProfileName := "io.youi"
22

33
pomExtra in Global := {
44
<url>https://github.com/outr/youi</url>

0 commit comments

Comments
 (0)