Skip to content

Commit

Permalink
Merge pull request #9 from TrueSparrowSystems/branding-changes
Browse files Browse the repository at this point in the history
Branding changes
  • Loading branch information
kedarchandrayan authored Jan 30, 2023
2 parents 941a6f6 + 2424c41 commit c4666b8
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 16 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## Base v2.0.0
- Republished package under @truesparrow

## Base v1.0.2
- LICENSE changes.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright © 2022 PLG Works
Copyright © 2022 True Sparrow Systems Pvt. Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Base
![npm version](https://img.shields.io/npm/v/@plgworks/base.svg?style=flat)

![npm version](https://img.shields.io/npm/v/@truesparrow/base.svg?style=flat)
Base provides frequently used functionality like cutome logger, response helper, Custom Promise and Instance composer.
These are used in almost all PLG Works repositories and hence the name `Base`.
These are used in almost all True Sparrow repositories and hence the name `Base`.

## Installation
```shell script
npm install @plgworks/base --save
npm install @truesparrow/base --save
```

## Logger
Expand All @@ -17,7 +16,7 @@ visually distinguished easily.
In the following snippet, we try to showcase all the logger methods with documentation in comments.

```js
const Base = require('@plgworks/base');
const Base = require('@truesparrow/base');
const Logger = Base.Logger;

// Constructor's first parameter is the module name. This is logged in every line to separate logs from multiple modules.
Expand Down Expand Up @@ -81,7 +80,7 @@ const paramErrorConfig = require(rootPrefix + '/tests/mocha/lib/formatter/paramE
// message and code goes in the error object.
const apiErrorConfig = require(rootPrefix + '/tests/mocha/lib/formatter/apiErrorConfig');

const Base = require('@plgworks/base');
const Base = require('@truesparrow/base');
const ResponseHelper = Base.responseHelper;

// Creating an object of ResponseHelper. Parameter is an object with key moduleName.
Expand Down Expand Up @@ -155,7 +154,7 @@ r1.toHash(); // Examples given above.
QueueManager provides various management options and configurations for a queue of Promises. Following is a brief
documentation of the various manager options and example usage.
```js
const Base = require('@plgworks/base'),
const Base = require('@truesparrow/base'),
logger = new Base.Logger("my_module_name");

const queueManagerOptions = {
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.2
2.0.0
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Index File for @plgworks/base
* Index File for @truesparrow/base
*/

const rootPrefix = '.',
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
{
"name": "@plgworks/base",
"version": "1.0.2",
"name": "@truesparrow/base",
"version": "2.0.0",
"description": "Base provides advanced Promise Queue Manager and other utilities.",
"main": "index.js",
"scripts": {
"pre-commit": "lint-staged"
},
"repository": {
"type": "git",
"url": "https://github.com/PLG-Works/base.git"
"url": "https://github.com/TrueSparrowSystems/base.git"
},
"keywords": [
"Base"
],
"author": "PLG Works",
"author": "True Sparrow",
"license": "MIT",
"bugs": {
"url": "https://github.com/PLG-Works/base/issues"
"url": "https://github.com/TrueSparrowSystems/base/issues"
},
"homepage": "https://github.com/PLG-Works/base",
"homepage": "https://github.com/TrueSparrowSystems/base",
"dependencies": {
"shortid": "2.2.16"
},
Expand Down

0 comments on commit c4666b8

Please sign in to comment.