From 997777a3187fdf1bb013e5dd230da4c37eef3ca5 Mon Sep 17 00:00:00 2001 From: Srie Teja Date: Fri, 27 Oct 2023 15:38:39 +0530 Subject: [PATCH] docs: removed unnecessary element from CHANGELOG.md --- CHANGELOG.md | 24 ++++-------------------- README.md | 3 --- 2 files changed, 4 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f222ac7..5f136ae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,21 +1,3 @@ - - -[![gitHub license](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE) -[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/at_java/badge)](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/at_java) - -# The atPlatform for Java developers - -This repo contains libraries, tools, samples and examples for developers who wish -to work with the atPlatform from Java code. - -NB: As of May 3 2022, the Java client library can still be considered a 1.0.0-Beta version - i.e. there may occasionally -be breaking changes, based on feedback from users of the library, until we get to a final version 1.0.0 - -### Contributions welcome! - -All of our software is open with intent. We welcome contributions - we want pull requests, and we want -to hear about issues. See also [CONTRIBUTING.md](CONTRIBUTING.md) - ## What's here / changelog ### Next ... * Getting started guide - from nothing to end-to-end-encrypted chat session in < 5 minutes @@ -62,5 +44,7 @@ to hear about issues. See also [CONTRIBUTING.md](CONTRIBUTING.md) * **Share** - a simple 'sender' client - shares some data with another @-sign * **Get** - gets data which was shared by another @-sign * **Delete** - deletes data that this Atsign previously shared with another - * To run them, having done a mvn install - `java -cp "target/at_client-1.0-SNAPSHOT.jar:target/lib/*" org.atsign.client.cli.REPL` (or Onboard/Share/Get/Delete ) + +#### Note: +As of May 3 2022, the Java client library can still be considered a 1.0.0-Beta version - i.e. there may occasionally +be breaking changes, based on feedback from users of the library, until we get to a final version 1.0.0 diff --git a/README.md b/README.md index b32f4c5..d0c753e 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,6 @@ This repo contains libraries, tools, samples and examples for developers who wish to work with the atPlatform from Java code. -NB: As of May 3 2022, the Java client library can still be considered a 1.0.0-Beta version - i.e. there may occasionally -be breaking changes, based on feedback from users of the library, until we get to a final version 1.0.0 - # Maven Depdendency The Java SDK can be added to your project through a compiled JAR or by Maven!