Skip to content

Commit 5597bec

Browse files
authored
Update README.md
1 parent 51ae5b4 commit 5597bec

File tree

1 file changed

+44
-18
lines changed

1 file changed

+44
-18
lines changed

README.md

+44-18
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,71 @@
1-
![Version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/abapPM/ABAP-XXX/src/zcl_XXX.clas.abap/c_version&label=Version&color=blue)
1+
<div align="center">
2+
<picture>
3+
<img width="300" height="120" alt="apm logo banner" src="https://github.com/abapPM/abapPM/blob/main/img/apm_banner.png?raw=true&ver=1.0.0">
4+
</picture>
5+
<p>&nbsp;</p>
6+
</div>
27

3-
[![License](https://img.shields.io/github/license/abapPM/ABAP-XXX?label=License&color=success)](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
8+
![Version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/abapPM/abapPM/src/core/zif_abappm_version.intf.abap/c_version&label=Version&color=blue)
9+
[![Download](https://img.shields.io/badge/Download-Click_Here-blue)](https://github.com/abapPM/abapPM/build/zabappm_standalone.abap)
10+
11+
[![License](https://img.shields.io/github/license/abapPM/abapPM?label=License&color=success)](LICENSE)
412
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?color=success)](https://github.com/abapPM/.github/blob/main/CODE_OF_CONDUCT.md)
5-
[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/ABAP-XXX)](https://api.reuse.software/info/github.com/abapPM/ABAP-XXX)
13+
[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/abapPM)](https://api.reuse.software/info/github.com/abapPM/abapPM)
14+
15+
# apm Types
616

7-
# XXX
17+
This repository contains an interface with the types and constants used by apm.
818

19+
apm is a *package manager* 📦 for ABAP applications and modules, a *website* 🌐, and a *registry* 📑.
920

21+
You can find the *website* at https://abappm.com and the *registry* at https://registry.abappm.com.
1022

11-
NO WARRANTIES, [MIT License](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
23+
NO WARRANTIES, [MIT License](LICENSE)
1224

1325
## Usage
1426

15-
...
27+
```abap
28+
"! Schema for package.abap.json
29+
TYPES BEGIN OF ty_package_json
1630
17-
## Prerequisites
31+
"! Full manifest
32+
TYPES BEGIN OF ty_manifest
1833
19-
SAP Basis 7.40 or higher
34+
"! Abbreviated manifest
35+
TYPES BEGIN OF ty_manifest_abbreviated
2036
21-
## Installation
37+
"! Full packument (as fetched from registry)
38+
"! Some fields are hoisted from latest version to root
39+
TYPES BEGIN OF ty_packument
2240
23-
Import ABAP XXX to your project using [apm](https://abappm.com).
41+
"! Supported Engines
42+
CONSTANTS BEGIN OF c_engine
2443
25-
```abap
26-
IMPORT '*' TO 'z$1_your_project$2' FROM 'xxx'.
27-
" or
28-
IMPORT '*' TO '/namespace/$1$2' FROM 'xxx'.
44+
"! Most Common Licenses (https://spdx.org/licenses/)
45+
CONSTANTS BEGIN OF c_license
46+
47+
"! Operating System Platforms
48+
CONSTANTS BEGIN OF c_os
49+
50+
"! Hardware Platforms
51+
CONSTANTS BEGIN OF c_cpu
52+
53+
"! Database Platforms
54+
CONSTANTS BEGIN OF c_db
2955
```
3056

3157
## Contributions
3258

33-
All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/ABAP-XXX/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request.
59+
All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/abapPM/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request.
3460

35-
You can install the developer version of ABAP XXX using [abapGit](https://github.com/abapGit/abapGit) either by creating a new online repository for https://github.com/abapPM/ABAP-XXX.
61+
Install `apm types` using [abapGit](https://github.com/abapGit/abapGit) by creating a new online repository for https://github.com/abapPM/abapPM-Types.
3662

37-
Recommended SAP package: `$XXX`
63+
Recommended SAP Package: `$APM-TYPES`
3864

3965
## About
4066

4167
Made with ❤️ in Canada
4268

4369
Copyright 2024 apm.to Inc. <https://apm.to>
4470

45-
Follow [@marcfbe](https://twitter.com/marcfbe) on X/Twitter or [marcfbe](https://linkedin.com/in/marcfbe) or LinkedIn
71+
Follow [@marcf.be](https://bsky.app/profile/marcf.be) on Bluesky or [@marcfbe](https://linkedin.com/in/marcfbe) on LinkedIn

0 commit comments

Comments
 (0)