Skip to content

Commit ad71805

Browse files
committed
Fill README and description
1 parent a9ce0f7 commit ad71805

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

README.md

+36-8
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# amaya-core [![maven-central](https://img.shields.io/maven-central/v/io.github.amayaframework/amaya-core?color=blue)](https://repo1.maven.org/maven2/io/github/amayaframework/amaya-core/)
1+
# amaya-core [![maven-central](https://img.shields.io/maven-central/v/io.github.amayaframework/amaya-core/2.0.0?color=blue)](https://repo1.maven.org/maven2/io/github/amayaframework/amaya-core/2.0.0)
22

3-
Placeholder
3+
An amaya framework module that implements a web application and its infrastructure.
44

55
## Getting Started
66

77
To install it, you will need:
88

99
* Java 11+
1010
* Maven/Gradle
11-
* Some Lib
11+
* Any amaya-server implementation (for example, [amaya-jetty](https://github.com/AmayaFramework/amaya-jetty))
1212

1313
## Installing
1414

1515
### Gradle dependency
1616

1717
```Groovy
1818
dependencies {
19-
implementation group: 'io.github.amayaframework', name: 'amaya-core', version: 'LATEST'
19+
implementation group: 'io.github.amayaframework', name: 'amaya-core', version: '2.0.0'
2020
}
2121
```
2222

@@ -26,18 +26,46 @@ dependencies {
2626
<dependency>
2727
<groupId>io.github.amayaframework</groupId>
2828
<artifactId>amaya-core</artifactId>
29-
<version>LATEST</version>
29+
<version>2.0.0</version>
3030
</dependency>
3131
```
3232

3333
## Usage example
3434

35-
Placeholder
35+
### Hello, world
36+
37+
<p>Gradle dependency section:</p>
38+
39+
```Gradle
40+
dependencies {
41+
implementation group: 'io.github.amayaframework', name: 'amaya-core', version: '2.0.0'
42+
implementation group: 'io.github.amayaframework', name: 'amaya-jetty', version: '1.0.0'
43+
}
44+
```
45+
46+
<p>Java code:</p>
47+
48+
```Java
49+
import io.github.amayaframework.core.WebBuilders;
50+
import io.github.amayaframework.jetty.JettyServerFactory;
51+
52+
public class Main {
53+
public static void main(String[] args) throws Throwable {
54+
var builder = WebBuilders.create();
55+
var app = builder
56+
.setServerFactory(new JettyServerFactory())
57+
.build();
58+
app.bind(8080);
59+
app.run(ctx -> System.out.println("Hello, world"));
60+
}
61+
}
62+
```
3663

3764
## Built With
3865

3966
* [Gradle](https://gradle.org) - Dependency management
40-
* [Black Magic]() - Black magic
67+
* [jfunc](https://github.com/RomanQed/jfunc) - Functional interfaces
68+
* [jakarta.servlet](https://projects.eclipse.org/projects/ee4j.servlet) - Servlet API
4169

4270
## Authors
4371

@@ -53,4 +81,4 @@ This project is licensed under the Apache License Version 2.0 - see the [LICENSE
5381

5482
## Acknowledgments
5583

56-
Thanks to everyone who was interested in this framework, gave advices and suggested ideas.
84+
Thanks to everyone who was interested in this framework, gave advices and suggested ideas.

build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ publishing {
8787
// Configure pom
8888
pom {
8989
name.set(archivesBaseName)
90-
description.set('Placeholder')
90+
description.set('An amaya framework module that implements a web application and its infrastructure.')
9191
url.set('https://github.com/AmayaFramework/amaya-core')
9292

9393
organization {

0 commit comments

Comments
 (0)