diff --git a/packages/common/PACKAGE.md b/packages/common/PACKAGE.md new file mode 100644 index 0000000000..0a0cd68fba --- /dev/null +++ b/packages/common/PACKAGE.md @@ -0,0 +1,3 @@ +Implements basic Angular directives and pipes, such as NgIf, NgForOf, DecimalPipe, and so on. + +The `CommonModule` exports are re-exported by `BrowserModule`, which is included automatically in the root `AppModule` when you create a new app with the CLI `new` command. \ No newline at end of file diff --git a/packages/common/http/PACKAGE.md b/packages/common/http/PACKAGE.md new file mode 100644 index 0000000000..6f7c16b0fa --- /dev/null +++ b/packages/common/http/PACKAGE.md @@ -0,0 +1,6 @@ +Implements an HTTP client API for Angular apps that relies on the `XMLHttpRequest` interface exposed by browsers. + +Includes testability features, typed request and response objects, request and response interception, +observable APIs, and streamlined error handling. + +For usage information, see the [HTTP Client](guide/http) guide. \ No newline at end of file diff --git a/packages/core/PACKAGE.md b/packages/core/PACKAGE.md new file mode 100644 index 0000000000..8224fb62f8 --- /dev/null +++ b/packages/core/PACKAGE.md @@ -0,0 +1,7 @@ +Implements Angular's core functionality, low-level services, and utilities. + +* Defines the class infrastructure for components, view hierarchies, change detection, rendering, and event handling. + +* Defines the decorators that supply metadata and context for Angular constructs. + +* Defines infrastructure for dependency injection (DI), internationalization (i18n), and various testing and debugging facilities. \ No newline at end of file diff --git a/packages/elements/PACKAGE.md b/packages/elements/PACKAGE.md new file mode 100644 index 0000000000..3ca7d69f7d --- /dev/null +++ b/packages/elements/PACKAGE.md @@ -0,0 +1,8 @@ +Implements Angular's custom-element API, which enables you to package components as +[custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). + +A custom element extends HTML by allowing you to define a tag whose content is created and controlled by JavaScript code. The browser maintains a `CustomElementRegistry` of defined custom elements (also called Web Components), which maps an instantiable JavaScript class to an HTML tag. + +The `createCustomElement()` function provides a bridge from Angular's component interface and change detection functionality to the built-in DOM API. + +For more information, see [Angular Elements Overview](guide/elements). \ No newline at end of file diff --git a/packages/http/PACKAGE.md b/packages/http/PACKAGE.md new file mode 100644 index 0000000000..4263f44ade --- /dev/null +++ b/packages/http/PACKAGE.md @@ -0,0 +1 @@ +Deprecated in favor of `@angular/common/http`. \ No newline at end of file diff --git a/packages/platform-browser/PACKAGE.md b/packages/platform-browser/PACKAGE.md new file mode 100644 index 0000000000..6891d8a1a5 --- /dev/null +++ b/packages/platform-browser/PACKAGE.md @@ -0,0 +1,7 @@ +Supports delivery of Angular apps on different supported browsers. + +The `BrowserModule` is included by default in any app created through the CLI, +and it re-exports the `CommonModule` and `ApplicationModule` exports, +making basic Angular functionality available to the app. + +For more information, see [Browser Support](guide/browser-support). \ No newline at end of file diff --git a/packages/router/PACKAGE.md b/packages/router/PACKAGE.md new file mode 100644 index 0000000000..ec7e9789f5 --- /dev/null +++ b/packages/router/PACKAGE.md @@ -0,0 +1,7 @@ +Implements the Angular Router service , which enables navigation from one view to the next as users perform application tasks. + +Defines the `Route` object that maps a URL path to a component, and the `RouterOutlet` directive +that you use to place a routed view in a template, as well as a complete API for configuring, querying, and controlling the router state. + +Import `RouterModule` to use the Router service in your app. +For more usage information, see the [Routing and Navigation](guide/router) guide. \ No newline at end of file diff --git a/packages/service-worker/PACKAGE.md b/packages/service-worker/PACKAGE.md new file mode 100644 index 0000000000..dff4d6764b --- /dev/null +++ b/packages/service-worker/PACKAGE.md @@ -0,0 +1,16 @@ +Implements a service worker for Angular apps. +Adding a service worker to an Angular app is one of the steps for turning it into a Progressive Web App (also known as a PWA). + +At its simplest, a service worker is a script that runs in the web browser and manages caching for an application. +Service workers function as a network proxy. They intercept all outgoing HTTP requests made by the application and can choose how to respond to them. + +To set up the Angular service worker in your project, use the CLI `add` command. +``` +ng add @angular/pwa +``` + +The command configures your app to use service workers by adding the service-worker package +and generating the necessary support files. + +For more usage information, see the [Service Workers](guide/service-worker-intro) guide. + diff --git a/packages/upgrade/PACKAGE.md b/packages/upgrade/PACKAGE.md new file mode 100644 index 0000000000..0074ea39a1 --- /dev/null +++ b/packages/upgrade/PACKAGE.md @@ -0,0 +1,2 @@ +Supports the upgrade path from AngularJS to Angular, allowing +components from both systems to be used in the same application. \ No newline at end of file