up readme

CHANGELOG.md

@@ -8,6 +8,8 @@ All notable changes to this project will be documented in this file.
 
 - urfave v2 implemented for commandline parameters
 - commands added for extracting and inserting
+- Added Todo
+- Added `goreportcard`
 
 ### Changed
 
@@ -16,7 +18,7 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
-- Links refers old repo are fixed
+- Links which refers old repo are fixed
 
 ## [0.1.0] - 2022-12-23
 

README.md

@@ -3,8 +3,11 @@
 <p align="center"></p>
 
 <div align="center">
-<img src="https://img.shields.io/badge/license-GPLv3-green">
-<img src="https://img.shields.io/badge/Go-v1.19-00ADD8">
+
+![License](https://img.shields.io/badge/license-GPLv3-green)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/blue-devil/nexeruncator)
+[![Go Report Card](https://goreportcard.com/badge/github.com/blue-devil/nexeruncator)](https://goreportcard.com/report/github.com/blue-devil/nexeruncator)
+
 </div>
 
 # neXeruncator
@@ -13,6 +16,20 @@ neXeruncator; extracts or inserts javascript source file from or into nexe-compi
 
 * The word `neXeruncator` is derived from `nexe` and `aberuncate`. Nothing special!
 
+## How to Build
+
+neXeruncator project created using Go version 1.19.
+Building project is as simple as running `go build`
+
+```bash
+go build main.go
+```
+
+## How to install
+
+neXeruncator can work as a standalone executable, you do not need to install it.
+Apply the build step.
+
 ## Notes
 
 From a reverse engineer's point of view, the nexe-compiled application consists of 4 main parts:
@@ -65,6 +82,8 @@ The first 8 byte is `codeSize` which is what I called jsInit. It is a kind og in
   * [ ] Print this info
 * [ ] Add to pkg.go.dev as a module
 * [ ] Finish documentation
+* [ ] Implement tests
+* [ ] Add pre-built binaries
 
 ## Resources