Skip to content
This repository has been archived by the owner on Apr 4, 2024. It is now read-only.

Marking the branch READ-ONLY #113

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Marking the branch READ-ONLY #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 2 additions & 30 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
image:https://github.com/eclipse-uprotocol/.github/raw/main/logo/uprotocol_logo.png[uProtocol, width=640]
**PROJECT IS NOW READ ONLY**

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[License,link=https://opensource.org/licenses/Apache-2.0]

*NOTE:* _Please refer to https://github.com/eclipse-uprotocol/uprotocol-spec[] for more information about uProtocol_

== Overview

This project contains the core data models (UUri, UAttributes, etc..) and core services definitions (uDiscovery, uSubscription, uTwin) of uProtocol. This project is used by other uprotocol projects such as the language specific SDKs and uLink library that extend the data model to add validators, serializers, and factory/builder methods.


=== How To Build?

The Project uses maven to build the protobuf message. The target to build the code is:

[source,bash]
----
mvn verify -f "pom.xml"
----

=== How To Use?
To pull the built (java) artifacts from maven central, add the following dependency to your pom.xml file:
[source]
----
<!-- uProtocol Core -->
<dependency>
<groupId>org.eclipse.uprotocol</groupId>
<artifactId>uprotocol-core-api</artifactId>
<version>1.5.0</version>
</dependency>
----
up-core-api has merged with https://github.com/eclipse-uprotocol/up-spec[up-spec] so that the project specs and core apis can be released/labeled together. Please refer to https://github.com/eclipse-uprotocol/up-spec/up-core-api[up-spec/up-core-api] for more information.
Loading