Skip to content

Commit 8ce2c19

Browse files
ljnelsonljnelson
authored
Prepares for release (#2)
Signed-off-by: Laird Nelson <[email protected]>
1 parent 06af6de commit 8ce2c19

File tree

4 files changed

+71
-2
lines changed

4 files changed

+71
-2
lines changed

‎README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# microBean™ Reference
2+
3+
[![Maven Central](https://img.shields.io/maven-central/v/org.microbean/microbean-reference.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.microbean/microbean-reference)
4+
5+
The microBean™ Reference project provides classes and interfaces assisting with implementing contextual references.
6+
7+
# Status
8+
9+
This project is currently experimental, in a pre-alpha state, and unsuitable for production use.
10+
11+
# Compatibility
12+
13+
**Until further notice, this project's APIs are subject to frequent backwards-incompatible signature and behavior
14+
changes, regardless of project version and without notice.**
15+
16+
# Requirements
17+
18+
microBean™ Reference requires a Java runtime of version 23 or higher.
19+
20+
# Installation
21+
22+
microBean™ Reference is available on [Maven Central](https://search.maven.org/). Include microBean™ Reference as a
23+
Maven dependency:
24+
25+
```xml
26+
<dependency>
27+
<groupId>org.microbean</groupId>
28+
<artifactId>microbean-reference</artifactId>
29+
<!-- Always check https://search.maven.org/artifact/org.microbean/microbean-reference for up-to-date available versions. -->
30+
<version>0.0.1</version>
31+
</dependency>
32+
```
33+
34+
# Documentation
35+
36+
Full documentation is available at [microbean.github.io/microbean-reference](https://microbean.github.io/microbean-reference/).

‎pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,13 @@
144144
<dependency>
145145
<groupId>org.microbean</groupId>
146146
<artifactId>microbean-attributes</artifactId>
147-
<version>0.0.2-SNAPSHOT</version>
147+
<version>0.0.2</version>
148148
</dependency>
149149

150150
<dependency>
151151
<groupId>org.microbean</groupId>
152152
<artifactId>microbean-bean</artifactId>
153-
<version>0.0.15-SNAPSHOT</version>
153+
<version>0.0.15</version>
154154
</dependency>
155155

156156
<dependency>

‎src/site/markdown/index.md.vm‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#include("../../../README.md")

‎src/site/site.xml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<site xmlns="http://maven.apache.org/SITE/2.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
5+
https://maven.apache.org/xsd/site-2.0.0.xsd"
6+
name="${project.name}"
7+
combine.self="merge">
8+
<bannerLeft name="${project.name}"/>
9+
<bannerRight href="${project.url}">
10+
<image src="https://avatars0.githubusercontent.com/u/25515632?s=60"/>
11+
</bannerRight>
12+
<version position="right"/>
13+
<skin>
14+
<groupId>org.apache.maven.skins</groupId>
15+
<artifactId>maven-fluido-skin</artifactId>
16+
<version>2.0.0</version>
17+
</skin>
18+
<body>
19+
<menu name="Documentation">
20+
<item name="Overview" href="index.html"/>
21+
<item name="JavaDocs" href="apidocs/index.html"/>
22+
<item name="Github Repository" href="${project.scm.url}"/>
23+
</menu>
24+
<menu ref="reports"/>
25+
</body>
26+
<custom>
27+
<fluidoSkin>
28+
<sideBarEnabled>true</sideBarEnabled>
29+
<topBarEnabled>false</topBarEnabled>
30+
</fluidoSkin>
31+
</custom>
32+
</site>

0 commit comments

Comments
 (0)