Merge pull request #2 from FranzDiebold/feat/v1.0.0

Feat/v1.0.0

Makefile

@@ -1,62 +1,65 @@
+.PHONY: help
+help:  ## Show this help.
+	@egrep '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-22s\033[0m %s\n", $$1, $$2}'
 
 .PHONY: install
-install:
+install:  ## Install dependencies
 	npm install
 
 .PHONY: test
-test:
+test:  ## Run tests for both library and demo application
 	npm run test
 
 .PHONY: test-lib
-test-lib:
+test-lib:  ## Run tests for library
 	npm run test-lib
 
 .PHONY: test-lib-ci
-test-lib-ci:
+test-lib-ci:  ## Run tests for library (CI)
 	npm run test-lib-ci
 
 .PHONY: test-demo
-test-demo:
+test-demo:  ## Run tests for demo application
 	npm run test-demo
 
 .PHONY: test-demo-ci
-test-demo-ci:
+test-demo-ci:  ## Run tests for demo application (CI)
 	npm run test-demo-ci
 
 .PHONY: lint
-lint:
+lint:  ## Lint both library and demo application
 	npm run lint
 
 .PHONY: lint-lib
-lint-lib:
+lint-lib:  ## Lint library
 	npm run lint-lib
 
 .PHONY: lint-demo
-lint-demo:
+lint-demo:  ## Lint demo application
 	npm run lint-demo
 
 .PHONY: build-lib
-build-lib:
+build-lib:  ## Build library
 	npm run build-lib
 
 .PHONY: build-lib-schematics
-build-lib-schematics:
+build-lib-schematics:  ## Build library schematics
 	npm run build-lib-schematics
 
 .PHONY: build-demo
-build-demo:
+build-demo:  ## Build demo application
 	npm run build-demo
 
 .PHONY: publish-lib
-publish-lib:
+publish-lib:  ## Publish library to npm
 	npm run build-lib-prod
 	npm run build-lib-schematics
 	cd dist/ng-google-sheets-db && npm publish
 
 .PHONY: serve-demo
-serve-demo:
+serve-demo:  ## Run demo application locally
 	npm run serve-demo
 
 .PHONY: deploy-demo
-deploy-demo:
+deploy-demo:  ## Deploy demo application to GitHub Pages
 	npm run deploy-demo

README.md

@@ -1,9 +1,13 @@
+<p align="center">
+  <img width="75" src="./design/ng-google-sheets-db-logo.png" alt="ng-google-sheets-db logo">
+</p>
+
 # ng-google-sheets-db - Angular Google Sheets DB
 
 [![Test, lint, build and deploy](https://github.com/FranzDiebold/ng-google-sheets-db-library/workflows/Test,%20lint,%20build%20and%20deploy/badge.svg)](https://github.com/FranzDiebold/ng-google-sheets-db-library/actions)
 [![demo: app](https://img.shields.io/badge/demo-app-2ca467.svg)](https://franzdiebold.github.io/ng-google-sheets-db-library/)
 [![demo: StackBlitz](https://img.shields.io/badge/demo-StackBlitz-1389fd.svg)](https://stackblitz.com/edit/ng-google-sheets-db-demo)
-[![Angular: v9](https://img.shields.io/badge/Angular-v9-DD0031.svg)](./projects/ng-google-sheets-db/package.json)
+[![Angular: v10](https://img.shields.io/badge/Angular-v10-DD0031.svg)](./projects/ng-google-sheets-db/package.json)
 [![npm](https://img.shields.io/npm/v/ng-google-sheets-db.svg)](https://www.npmjs.com/package/ng-google-sheets-db)
 [![npm](https://img.shields.io/npm/dm/ng-google-sheets-db.svg)](https://www.npmjs.com/package/ng-google-sheets-db)
 [![license: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](./LICENSE)

design/README.md

@@ -0,0 +1,14 @@
+# Design
+
+## Logo
+
+<img width="200" height="200" src="ng-google-sheets-db-logo.png">
+
+## Colors
+
+- green ![#2ca467](https://placehold.it/20/2ca467/000000?text=+) `#2ca467`
+- gray ![#606c76](https://placehold.it/20/606c76/000000?text=+) `#606c76`
+
+## Preview image for social media
+
+![ng-google-sheets-db social media preview image](ng-google-sheets-db-social-media-preview.png)