slack-block-builder - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

 # Change Log
 
+## v0.1.3 - 2020-06-13
+
+* Add project logo (kudos to Alexey Chernyshov).
+* Beautify README.md for project.
+* Update images to reflect new logo.
+
 ## v0.1.2 - 2020-06-12
@@ -4,0 +10,0 @@

package.json

 {
   "name": "slack-block-builder",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Lightweight, zero-dependency library for creating Slack messages and modals, with a builder interface inspired by SwiftUI.",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -0,15 +1,39 @@
+<p align="center">
+    <img src="https://raw.githubusercontent.com/raycharius/slack-block-builder/master/resources/images/main/logo-horizontal.png" alt="Logo" width="600px">
+</p>
 
-:notebook: **Note:** Thorough, in-depth docs are in the process and will be available by **mid-June**.
+<p align="center">
+    <h3 align="center">Maintainable code for Slack interactive messages, modals, and home tabs.</h3>
+</p>
 
-# Block Builder
+<p align="center">
+    Lightweight, zero-dependency JavasScript library for <strong>Slack Block Kit UI</strong>.
+    <br />
+    <br />
+    <a href="#mag--real-world-examples"><strong>View Real-World Examples »</strong></a>
+    <br />
+    <br />
+    <a href="#space_invader--usage">Quick Start Guide</a>
+    ·
+    <a href="https://github.com/raycharius/slack-block-builder/issues">Request Feature</a>
+    ·
+    <a href="https://github.com/raycharius/slack-block-builder/issues">Report Bug</a>
+  </p>
+</p>
 
+![An example of using Block Builder](resources/images/main/hero-image.png)
+
+***
+
+[![npm](https://img.shields.io/npm/v/slack-block-builder?color=bright-green)](https://www.npmjs.com/package/slack-block-builder)
+![NPM](https://img.shields.io/npm/l/slack-block-builder?color=bright-green)
 [![codecov](https://codecov.io/gh/raycharius/slack-block-builder/branch/master/graph/badge.svg)](https://codecov.io/gh/raycharius/slack-block-builder)
 [![Maintainability](https://api.codeclimate.com/v1/badges/17a96b146284b1b82b9e/maintainability)](https://codeclimate.com/github/raycharius/slack-block-builder/maintainability)
 
-**Block Builder** is a lightweight, dependency-free JavaScript library for creating interactive messages, modals, and home tabs for Slack, with a builder syntax inspired by [SwiftUI](https://developer.apple.com/xcode/swiftui/).
+**Block Builder** helps you keep your Slack app code for UI maintainable, testable, and reusable. It has a simple builder syntax inspired by [SwiftUI](https://developer.apple.com/documentation/swiftui) and lets you code the _you_ want to code.
 
-![An example of using Block Builder](resources/images/main/hero.png)
 
-## :zap:  Features
 
+## :zap: &nbsp; Features
+
 * Simple [SwiftUI](https://developer.apple.com/xcode/swiftui/)-inspired syntax.
@@ -24,3 +48,3 @@ * Builder syntax for better visual code structure.
 
-#### :hammer:  Coming Soon
+## :rocket: &nbsp; Coming Soon
 
@@ -34,3 +58,3 @@ * In-depth doc site.
 
-## :gift:  Benefits
+## :gift: &nbsp; Benefits
 
@@ -44,3 +68,3 @@ * Write three times less code.
 
-## :floppy_disk:  Installation 
+## :floppy_disk: &nbsp; Installation 
 
@@ -59,3 +83,3 @@ #### Using NPM:
 
-## :space_invader:  Usage
+## :space_invader: &nbsp; Usage
 
@@ -478,3 +502,3 @@ * [**Importing**](#importing)
 
-While you can definitely use traditional `if` statements, you can also pass in potentially undefined values, inline ternary expressions, the `&&` operator, or even self-invoking functions. Below there is a [real-world example](#conditionals-real-world-example), but let's first take a look at the basics:
+While you can definitely use traditional `if` statements, you can also pass in potentially undefined values, inline ternary expressions, the `&&` operator, or even self-invoking functions. Below there is a [real-world example](#mag--real-world-examples), but let's first take a look at the basics:
 
@@ -557,4 +581,6 @@ ```javascript
 
-#### Conditionals Real-World Example
+## :mag: &nbsp; Real-World Examples
 
+### Conditionals
+
 Let's say you have an app that manages team rosters, through a [Slack](https://slack.com) modal. 
@@ -620,3 +646,3 @@
 
-## Other Useful Slack-Related Projects
+## :link: &nbsp; Other Useful Slack-Related Projects
 
@@ -627,11 +653,12 @@ [Bolt for Javascript](https://github.com/SlackAPI/bolt) – A simple framework for building [Slack](https://slack.com) apps, developed by [Slack](https://slack.com) themselves.
 
-## Author
+## :fire: &nbsp; Acknowledgements
+ 
+<img src="https://github.com/bravecow.png" alt="@bravecow" width="24" height="24" valign="bottom" /> Taras Neporozhniy ([@bravecow](https://github.com/bravecow)) - For all of the advice!
 
-<img src="https://github.com/raycharius.png" alt="@raycharius" width="24" height="24" valign="bottom" /> Ray East ([@raycharius](https://github.com/raycharius)) - Huge Fan of Slack and Block Builder Maintainer
+<img src="https://cdn.dribbble.com/users/683635/avatars/normal/ee2c7c826bfe244b573d145376fe0b5a.png?1510328842" alt="@ft502" width="24" height="24" valign="bottom" /> Alexey Chernyshov ([@ft502](https://dribbble.com/ft502) on Dribbble) - For such a beautiful logo!
 
-## License
+<img src="https://github.com/slackhq.png" alt="@slackhq" width="24" height="24" valign="bottom" /> SlackHQ ([@slackhq](https://github.com/slackhq)) - For such a wonderful product and API!
 
-[MIT License](LICENSE)
+## :black_nib: &nbsp; Author
 
-
-
+<img src="https://github.com/raycharius.png" alt="@raycharius" width="24" height="24" valign="bottom" /> Ray East ([@raycharius](https://github.com/raycharius)) - Huge Fan of Slack and Block Builder Maintainer

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

169717

increased by1.06%

Number of lines in readme file

657

increased by4.29%

No dependency changes