Browse Source

README: Restructure library section.

Also move "Getting started" there,
as making new projects only makes sense
if project is to be used as a library.
Herby Vojčík 4 years ago
parent
commit
b32fa374c4
1 changed files with 5 additions and 8 deletions
  1. 5 8
      grunt-init-project/root/README.md

+ 5 - 8
grunt-init-project/root/README.md

@@ -2,17 +2,14 @@
 
 {%= description %}
 
-## Getting Started
+## Use {%= name %} library in your project
 
-Install Amber and create an Amber project,
-as shown in [Amber Instructions](https://lolg.it/amber/amber#prerequisities).
-
-## Use {%= name %} as a library in a client project
+**DELETE THIS PARAGRAPH, IF {%= name %} IS A LIBRARY. DELETE WHOLE THIS SECTION IF {%= name %} IS AN APP, NOT A LIBRARY.**
 
-If not already present, create a client project
-in an empty directory with `amber init`.
+If not already done, install Amber and create an Amber project with `amber init`,
+as shown in [Amber Instructions](https://lolg.it/amber/amber#prerequisities).
 
-In a client project, run
+In a project, run
 
 ```sh
 npm install {%= name %} --save