@fundamental-ngx/platform 0.62.0-rc.8 → 0.62.0-rc.80

package/README.md

@@ -1,109 +1,50 @@
-# @Fundamental-NGX/platform
+# @fundamental-ngx/platform
 
-[![npm version](https://badge.fury.io/js/%40fundamental-ngx%2Fcore.svg)](//www.npmjs.com/package/@fundamental-ngx/platform)
+[![npm version](https://badge.fury.io/js/%40fundamental-ngx%2Fplatform.svg)](//www.npmjs.com/package/@fundamental-ngx/platform)
 ![Build Status](https://github.com/SAP/fundamental-ngx/actions/workflows/create-release.yml/badge.svg?branch=main)
 ![npm](https://img.shields.io/npm/dm/@fundamental-ngx/platform?label=npm%20downloads)
 [![Slack](https://img.shields.io/badge/slack-ui--fundamentals-blue.svg?logo=slack)](https://ui-fundamentals.slack.com)
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/fundamental-ngx)](https://api.reuse.software/info/github.com/SAP/fundamental-ngx)
 
-## Content
+## Description
 
-- [1. Description](#1)
-- [2. Requirements](#2)
-- [3. Versioning](#3)
-- [4. Getting Started](#4)
-- [5. Known Issues](#5)
-- [6. Support](#6)
-- [7. Contributing](#7)
-- [8. License](https://github.com/SAP/fundamental-ngx/blob/main/LICENSE.txt)
-- [9. Similar Projects](#8)
+`@fundamental-ngx/platform` is built on top of `@fundamental-ngx/core` to provide higher-level components with built-in form integration, data binding, and application-level patterns. It abstracts common implementation details to boost productivity.
 
-## <a name="1"></a>1. Description
+See the [Component Documentation](https://sap.github.io/fundamental-ngx) for examples and API details.
 
-The `@fundamental-ngx/platform` library is a set of [Angular](https://angular.io/) components built using [Fundamental Library Styles](https://sap.github.io/fundamental-styles/).
+## Requirements
 
-The Fundamental Library for Angular is an SAP Design System Angular component library used to build modern product user experiences with the SAP look and feel.
+Angular 21 or newer. Prior knowledge of Angular is recommended.
 
-See [Component Documentation](https://sap.github.io/fundamental-ngx/#/core/new-component) for examples and API details.
+## Getting Started
 
-## <a name="2"></a>2. Requirements
+```bash
+ng add @fundamental-ngx/platform
+```
 
-To download and use Fundamental Library for Angular, you will first need to install the [node package manager](https://www.npmjs.com/get-npm).
+Import individual components (standalone by default):
 
-Fundamental Library for Angular is intended for use with Angular 15 or newer.
+```typescript
+import { PlatformTableModule } from '@fundamental-ngx/platform/table';
+import { PlatformSearchFieldModule } from '@fundamental-ngx/platform/search-field';
+```
 
-Prior knowledge of Angular is recommended, to use the fundamental-ngx library.
+## Versioning
 
-## <a name="3"></a>3. Versioning
+Check the [Breaking Changes](https://github.com/SAP/fundamental-ngx/wiki#breaking-changes) for upgrade guidance.
 
-npm package [fundamental-ngx](https://npmjs.com/package/fundamental-ngx) version `0.10.0` is compiled with Angular 7. It supports Angular 6 and 7 versions.
-This version is not supported by bug fixes.
+## Known Issues
 
-npm package [@fundamental-ngx/platform](https://www.npmjs.com/package/@fundamental-ngx/platform) version `0.11.x` is compiled with Angular 8.
-It supports Angular 8 version and newer. This version will have merged some bug-fixes.
+See [Issues](https://github.com/SAP/fundamental-ngx/issues).
 
-npm package [@fundamental-ngx/platform](https://www.npmjs.com/package/@fundamental-ngx/platform) versions `0.12.y - 0.15.z` are compiled with Angular 8.
-It supports the current Angular 8 version and newer. This version also can be used along with enabled IVY.
-
-npm package [@fundamental-ngx/platform](https://www.npmjs.com/package/@fundamental-ngx/platform) versions `0.16.y - 0.18.z` are compiled with Angular 8.
-It supports the current Angular 9 version and newer. This version also can be used along with enabled IVY.
-
-Check the [Breaking Changes](https://github.com/SAP/fundamental-ngx/wiki#breaking-changes) for the latest patches changes.
-
-## <a name="4"></a>4. Getting Started
-
-For an existing Angular CLI application,
-
-0. **Video tutorial**
-   [How to use the Fundamental Core Library](https://www.youtube.com/watch?v=i4VIiuzD2Fg)
-
-1. **Install Fundamental-NGX.**
-   `ng add @fundamental-ngx/platform`
-   For models prior to 0.10 use `fundamental-ngx`
-
-    _If you do not use the Angular CLI or if this command does not work for you, please see the [full installation guide](https://github.com/SAP/fundamental-ngx/wiki/Full-Installation-Guide)._
-
-1. **Edit your tsconfig.**
-   Edit the `target` in your `tsconfig.json` to `es5`. The library is incompatible with later versions.
-1. **Import the modules you want to use.**
-
-    To add the entire library, add the following import to your main application module.
-
-    ```typescript
-    import { FundamentalNgxPlatformModule } from '@fundamental-ngx/platform';
-
-    @NgModule({
-        ...
-        imports: [FundamentalNgxPlatformModule],
-    })
-    export class DemoModule { }
-    ```
-
-    To include an individual Angular Fundamental component in your application, you only need to import the relevant module.
-
-1. **Provide the RtlService.**
-   In your main application module, add `RtlService` to the list of providers. This service is needed to ensure proper right-to-left functionality for
-   users with their browser set to an RTL language.
-1. **Provide the ContentDensityService.**
-   In your main application module, you will also need to add `ContentDensityService` to the list of providers if you wish to manage the content density of
-   you application from a single point.
-
-1. **Add the component to your HTML.**
-
-## <a name="5"></a>5. Known Issues
-
-Please see [Issues](https://github.com/SAP/fundamental-ngx/issues).
-
-## <a name="6"></a>6. Support
+## Support
 
 If you encounter an issue, you can [create a ticket](https://github.com/SAP/fundamental-ngx/issues).
 
-## <a name="7"></a>7. Contributing
-
-If you want to contribute, please check the [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) documentation for contribution guidelines. Please follow the [Angular commit message guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
+## Contributing
 
-Check out the [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) guide on building a new component for the library and creating the necessary documentation for your new component.
+See [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) for guidelines and [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) for building new components.
 
-## <a name="9"></a>8. Similar Projects
+## License
 
-[Fundamental-react](https://github.com/SAP/fundamental-react) - React implementation of Fundamental Library Styles
+See [LICENSE.txt](https://github.com/SAP/fundamental-ngx/blob/main/LICENSE.txt).