From 3aec36878c8b2aa9cf335b7a2220ae448c359fa1 Mon Sep 17 00:00:00 2001 From: Yelin Zhang <30687616+Yelinz@users.noreply.github.com> Date: Wed, 29 May 2024 14:57:57 +0200 Subject: [PATCH] Improve installation documentation text (#1818) --- .../public-pages/docs/installation.hbs | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/app/templates/public-pages/docs/installation.hbs b/docs/app/templates/public-pages/docs/installation.hbs index db5faf441..e2941286c 100644 --- a/docs/app/templates/public-pages/docs/installation.hbs +++ b/docs/app/templates/public-pages/docs/installation.hbs @@ -1,8 +1,8 @@

Installation

- Ember-power-select is distributed as an Ember-cli addon, - so the major part of installation will be done by following command on your ember project directory + Ember Power Select is distributed as an Ember CLI addon, + so the majority of the installation will be done by running the following command in your Ember project directory:

@@ -10,42 +10,42 @@

- When installing this through ember install the addon will add the necessary snippet above - automatically in your app. + When installing via ember install, the addon will automatically add the necessary snippets to your app.

- The addon is using internal ember-concurrency. ember-concurrency needs some manual steps. For this steps see ember-concurrency -> "Configure Babel Transform" on installation page. + The addon uses ember-concurrency internally, which require some manual steps for installation. For these steps, see the ember-concurrency installation page under "Configure Babel Transform".

-

Manual installation

+

Manual Installation

- If you don't have used ember install you need to add ember-basic-dropdown and ember-concurrency as devDependencies in package.json. + If you haven't used ember install, you need to add ember-basic-dropdown and ember-concurrency as devDependencies in your package.json.

- After the installation you need to add the following lines somewhere in your templates where you want to render the power select content into e.g. your application.hbs. - In this component will be rendered the power select content. + After installation, add the following line to the templates where you want to render the power select content, such as in your application.hbs. + This component will render the power select content.

- If you use vanilla CSS, you need to add the following line into app.js or in any route/controller/component .js/.ts file: + If you use vanilla CSS, add the following line to your app.js or any route/controller/component .js/.ts file:

- Instead of adding the styling in an .js file and depending from your build config you can also add the css in any template/component css file by using following line + Instead of adding the styling in a .js file. + Depending on your build config you can also add the CSS in any template/component CSS file using the following line:

{{!-- template-lint-disable no-potential-path-strings --}}

- However, if you are using SASS or LESS you need to add an import statement to your styles. + If you are using SASS or LESS, you need to add an import statement to your styles.

{{#let (get-code-snippet "installation-1.scss") as |snippet|}} @@ -53,7 +53,7 @@ {{/let}}

- If you are using LESS there is also necessary to register the paths in lessOptions + For LESS, you also need to register the paths in lessOptions.

{{#let (get-code-snippet "installation-2.js") as |snippet|}} @@ -61,17 +61,17 @@ {{/let}}

- This explicit import is needed because using css preprocessors like SASS and LESS allows you to - customize the appearance of ember-power-select using variables. This is easier and generates less + This explicit import is needed because using CSS preprocessors like SASS and LESS allows you to + customize the appearance of ember-power-select using variables. This method is easier and generates less code than overriding styles you don't like.

- More information about style in Basic customization: Styles + For more information about styling, see Basic Customization: Styles.

- The addon is using internal ember-concurrency. For installation see ember-concurrency installation page. + For further details on ember-concurrency installation, visit the ember-concurrency installation page.