Skip to content

Commit 4ae7779

Browse files
authored
Merge pull request #2 from cap-js/docs__guidelines-review
docs: Adjusted README.md as per SAP guidelines
2 parents 29ba7a9 + f7cabb7 commit 4ae7779

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# Welcome to @print
22

3+
[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/print)](https://api.reuse.software/info/github.com/cap-js/print)
4+
35
## About this project
46

57
`@print` is a CDS plugin providing print service features, [SAP Print Service](https://api.sap.com/api/PRINTAPI/overview).
68

7-
89
## Table of Contents
910

1011
- [About this project](#about-this-project)
1112
- [Requirements](#requirements)
1213
- [Setup](#setup)
1314

14-
## Requirements
15+
## Requirements and Setup
1516

1617
See [Getting Started](https://cap.cloud.sap/docs/get-started) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model.
1718

18-
## Setup
19+
Usage of this plugin requires a valid subscription of the [SAP Print Service](https://help.sap.com/docs/SCP_PRINT_SERVICE).
1920

2021
To integrate the print functionality in your application, simply annotate any action with `@print`. This annotation automatically manages the process of sending documents to the print queues, requiring no additional setup for handling print jobs.
2122

@@ -140,4 +141,20 @@ If you are running the application in a production way locally(E.g. adding VCAP_
140141
"scripts": {
141142
"start": "SUBSCRIBER_SUBDOMAIN_FOR_LOCAL_TESTING=sub01 cds-serve"
142143
}
143-
```
144+
```
145+
146+
## Support, Feedback, Contributing
147+
148+
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/print/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).
149+
150+
## Security / Disclosure
151+
152+
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/print/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
153+
154+
## Code of Conduct
155+
156+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
157+
158+
## Licensing
159+
160+
Copyright 2025 SAP SE or an SAP affiliate company and print contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/print).

0 commit comments

Comments
 (0)