Skip to content

Commit f20ca39

Browse files
committed
First pass at renaming and syncing up
1 parent 80a357b commit f20ca39

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# @arcgis/core
22

3-
A minified, unbuilt version of the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/) ES modules.
3+
A minified, unbuilt version of the [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript/) ES modules.
44

55
## Features
66

7-
You can install these modules via [npm](https://npmjs.org/) and then use them directly in a framework such as [React](https://reactjs.org/), [Vue.js](https://vuejs.org) or [Angular](https://cli.angular.io/). Or, you can also create your own custom builds with [Webpack](https://webpackjs.org) or [rollup.js](https://rollupjs.org/guide/en/).
7+
For an overview of the SDK, visit the [developer documentation](https://developers.arcgis.com/javascript/latest/key-features/) site.
8+
9+
You can install these modules with [npm](https://npmjs.org/) and then use them directly in a framework such as [React](https://reactjs.org/), [Vue.js](https://vuejs.org) or [Angular](https://cli.angular.io/). Or, you can also create your own custom builds with [Webpack](https://webpackjs.org) or [rollup.js](https://rollupjs.org/guide/en/).
10+
11+
The SDK includes [TypeScript](https://www.typescriptlang.org/) type definitions. The `.d.ts` declaration files are bundled with the install.
812

913
Sample applications can be found at [github.com/jsapi-resources/](https://github.com/Esri/jsapi-resources/tree/master/esm-samples).
1014

@@ -18,32 +22,34 @@ npm install @arcgis/core
1822

1923
## Configure CSS
2024

21-
Set the CSS to the same version as the installed API modules. You can verify the installed API version by running `npm list @arcgis/core`. If you are working with local assets skip to the *Manage assets locally* section.
25+
Set the CSS to the same version as the installed SDK modules. You can verify the installed SDK version by running `npm list @arcgis/core`. If you are working with local assets skip to the *Manage assets locally* section.
2226

23-
The first example shows importing CSS for production API version `4.19.0`:
27+
The first example shows importing CSS for production SDK version `4.25.0`:
2428

2529
*index.css*
2630

2731
```css
28-
@import "https://js.arcgis.com/4.19/@arcgis/core/assets/esri/themes/light/main.css";
32+
@import "https://js.arcgis.com/4.25/@arcgis/core/assets/esri/themes/light/main.css";
2933
```
3034

31-
The second example shows importing CSS for `next` API version `4.19.0-next.20210324`:
35+
The second example shows importing CSS for `next` SDK version `4.19.0-next.20210324`:
3236

3337
*index.css*
3438

3539
```css
36-
@import "https://cdn.jsdelivr.net/npm/@arcgis/core@4.19.0-next.20210324/assets/esri/themes/light/main.css";
40+
@import "https://cdn.jsdelivr.net/npm/@arcgis/core@4.25.0-next.20220921/assets/esri/themes/light/main.css";
3741
```
3842

3943
## Working with assets
4044

41-
For most local builds, the API's assets are automatically pulled from a CDN at runtime and there is no need for additional configuration. The assets include styles, images, web workers, wasm and localization files. Production versions of the API use the ArcGIS CDN, and `next` builds (e.g. `4.19.0-next.20210324`) use jsDelivr, similar to the CSS example above.
45+
The default configuration for local builds is for the SDK to automatically pull assets from a CDN at runtime, there is no need for additional configuration. The assets include styles, images, web workers, wasm and localization files. Production versions of the SDK's assets are hosted on the ArcGIS CDN, and `next` builds (e.g. `4.25.0-next.20220921`) use assets hosted on the jsDelivr CDN.
4246

4347
### Manage assets locally
4448

4549
If you need to manage the assets locally, copy them into your project from `/node_modules/@arcgis/core/assets`, and then set `config.assetsPath` to insure requests for assets are resolved correctly. A simple way to accomplish this is to configure an npm script that runs during your build process. For example, use npm to install `ncp` and configure a script in package.json to copy the folder.
4650

51+
**Important:** Every time you upgrade the SDK, be sure to recopy the new version of the assets to your project. This ensures the assets stay synchronized.
52+
4753
Here’s a React example:
4854

4955
*package.json*
@@ -115,22 +121,22 @@ Windows users can use [`xcopy`](https://docs.microsoft.com/en-us/windows-server/
115121

116122
## Requirements
117123

118-
Use of the ArcGIS API for JavaScript is subject to the terms described in the product-specific [terms of use.](https://www.esri.com/en-us/legal/terms/product-specific-scope-of-use) Learn more about licensing [here](https://developers.arcgis.com/javascript/latest/licensing/).
124+
Use of the ArcGIS Maps SDK for JavaScript is subject to the terms described in the product-specific [terms of use.](https://www.esri.com/en-us/legal/terms/product-specific-scope-of-use) Learn more about licensing [here](https://developers.arcgis.com/javascript/latest/licensing/).
119125

120126
## Resources
121127

122-
- [ArcGIS for JavaScript](https://developers.arcgis.com/javascript/)
128+
- [ArcGIS Maps SDK JavaScript](https://developers.arcgis.com/javascript/)
123129
- [http://blogs.esri.com/esri/arcgis/tag/javascript/](https://blogs.esri.com/esri/arcgis/tag/javascript/)
124130
- [twitter@ArcGISJSAPI](https://twitter.com/ArcGISJSAPI)
125131

126132
## Issues
127133

128-
- General questions about using these modules or the ArcGIS API for JavaScript? See the [Esri developer community](https://community.esri.com/t5/arcgis-api-for-javascript/ct-p/arcgis-api-for-javascript).
134+
- General questions about using these modules or the ArcGIS Maps SDK for JavaScript? See the [Esri developer community](https://community.esri.com/t5/arcgis-api-for-javascript/ct-p/arcgis-api-for-javascript).
129135
- [Technical support](https://support.esri.com/).
130136

131137
## Licensing
132138

133-
COPYRIGHT © 2021 Esri
139+
COPYRIGHT © 2022 Esri
134140

135141
All rights reserved under the copyright laws of the United States
136142
and applicable international laws, treaties, and conventions.

0 commit comments

Comments
 (0)