Skip to content

Commit 79857b9

Browse files
committed
Added CHANGELOG.md, updated README.md and version
1 parent 1b075c3 commit 79857b9

File tree

3 files changed

+53
-2
lines changed

3 files changed

+53
-2
lines changed

CHANGELOG.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## Version 3.9.0 - tbd
9+
10+
### Added
11+
12+
- Initial release of the plugin.
13+
14+
### Changed
15+
16+
17+
### Deprecated
18+
19+
20+
### Removed
21+
22+
23+
### Fixed
24+
25+
26+
### Security
27+
28+
29+
## Diffs
30+
31+
[unreleased]: https://github.com/cap-java/cds-feature-advanced-event-meshg/compare/v3.9.0...HEAD
32+
[3.9.0]: https://github.com/cap-java/cds-feature-advanced-event-mesh/releases/tag/v3.9.0

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,32 @@ CDS plugin providing integration with SAP Integration Suite, advanced event mesh
88

99
## Requirements and Setup
1010

11-
*Insert a short description what is required to get your project running...*
11+
See [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell?impl-variant=java) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model.
12+
13+
### SAP Integration Suite, advanced event mesh
14+
15+
For details on how to use SAP Integration Suite, advanced event mesh, please see the [SAP Integration Suite, advanced event mesh Service Guide](https://TODO).
16+
17+
### CDS Plugin
18+
19+
The usage of CAP Java plugins is described in the [CAP Java Documentation](https://cap.cloud.sap/docs/java/building-plugins#reference-the-new-cds-model-in-an-existing-cap-java-project). Following this documentation this plugin needs to be referenced in the `srv/pom.xml` of a CAP Java project:
20+
21+
```xml
22+
<dependency>
23+
<groupId>com.sap.cds</groupId>
24+
<artifactId>cds-feature-advanced-event-mesh</artifactId>
25+
<version>${latest-version}</version>
26+
</dependency>
27+
```
28+
29+
The latest version can be found in the [changelog](./CHANGELOG.md) or in the [Maven Central Repository](https://central.sonatype.com/artifact/com.sap.cds/cds-feature-advanced-event-mesh/versions).
1230

1331
## Support, Feedback, Contributing
1432

1533
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-java/cds-feature-advanced-event-mesh/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
1634

1735
## Security / Disclosure
36+
1837
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-java/cds-feature-advanced-event-mesh/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
1938

2039
## Code of Conduct

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</developers>
2424

2525
<properties>
26-
<revision>4.1.0-SNAPSHOT</revision>
26+
<revision>3.9.0-SNAPSHOT</revision>
2727
<java.version>17</java.version>
2828
<maven.compiler.release>${java.version}</maven.compiler.release>
2929
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

0 commit comments

Comments
 (0)