@ngbracket/ngx-layout - npm Package Compare versions

Comparing version 16.1.2 to 16.1.3

package.json

 {
   "name": "@ngbracket/ngx-layout",
-  "version": "16.1.2",
+  "version": "16.1.3",
   "exports": {
@@ -97,2 +97,2 @@ "./mq": {
   "sideEffects": false
-}
+}

README.md

@@ -1,6 +0,42 @@
-# ngx-layout
+# @ngbracket/ngx-layout
 
-The sources for this package are in the main [ngbracket/ngx-layout](https://github.com/ngbracket/ngx-layout) repo.
-Please file issues and pull requests against that repo.
+### The Angular team no longer publishes new releases of this project. Please see [this article](https://medium.com/@caerus.karu/farewell-flex-layout-aaa567023769) for the explanation and next steps.
 
+This project is a port of @angular/flex-layout as this is still a very well used library and something I have used extensively in the past, and wanted to give something back to the Angular community by trying to keep this project alive for as long as possible.
+
+If you would like to contribute to the project please get in touch with me on [twitter](https://twitter.com/duncanfaulkner). Alternatively, if you would like to sponsor the project details can be found on our [GitHub page](https://github.com/sponsors/ngbracket).
+
+Thank you for your support.
+
+### Getting Started
+
+Start by installing the ngx-layout library from `npm`
+
+```
+npm i -s @ngbracket/ngx-layout @angular/cdk
+```
+
+Next, you'll need to import the Layout module in your app's module.
+
+**app.module.ts**
+
+```ts
+import { FlexLayoutModule } from '@ngbracket/ngx-layout';
+...
+
+@NgModule({
+    ...
+    imports: [ FlexLayoutModule ],
+    ...
+});
+```
+
+After that is configured, you can use the ngx-layout attributes in your HTML tags for flex layout:
+
+```html
+<div fxLayout="row" fxLayoutAlign="space-between"></div>
+```
+
+---
+
 License: MIT

No alert changes

Improved metrics

Total package byte prevSize

1650248

increased by0.07%

Number of lines in readme file

43

increased by514.29%

No dependency changes