Skip to content

Commit

Permalink
UPDATED: NPM Package information
Browse files Browse the repository at this point in the history
  • Loading branch information
SagnikGanguly96 committed Dec 14, 2022
1 parent 493edbf commit 4dc1d8d
Show file tree
Hide file tree
Showing 3 changed files with 1,340 additions and 144 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,17 @@ Download the latest version of **_SGNUIKit_** from:
[sgnuikit.repository.sgnetworks.eu.org/downloads](https://sgnuikit.repository.sgnetworks.eu.org/downloads/) or
[github.com/SGNetworksIndia/SGNUIKit/releases](https://github.com/SGNetworksIndia/SGNUIKit/releases), and extract the archive on the on any directory you want (preferably, `/assets/vendor/`).

Now add the following line of code `<script src="/assets/vendor/SGNUIKit/js/SGNUIKit.loader.js"></script>` between the `<head></head>` tags.
And the rest will be taken care of by the *loader*.
Now add the following line of code `<script src="/assets/vendor/SGNUIKit/js/SGNUIKit.loader.js"></script>` between the `<head></head>` tags. And the rest will be taken care of by the *loader*.

Now you are ready to start developing your website using **_SGNUIKit_**.
For more information, read the [documentation](#documentation).
Now you are ready to start developing your website using **_SGNUIKit_**. For more information, read the [documentation](#documentation).

We suggest you to set up **_AppCache_** and a **_Service Worker_** to enable caching. Doing so will make the web pages to load faster and your website will be able to load even in offline and
there are many other good reasons to set up **_AppCache_** and a **_Service Worker_**, one of them is it enables you to use **_Push Notification_** service.
We recommend you to do this as the main script is larger than **1MB** (approximately, **3.6MB**).

## DOCUMENTATION

The documentation for **_SGNUIKit_** is available at [sgnuikit.repository.sgnetworks.eu.org/docs](https://sgnuikit.repository.sgnetworks.eu.org/docs/) and a tutorial on setting up a **_Progressive Web
App (PWA)_**
The documentation for **_SGNUIKit_** is available at [sgnuikit.cdn.sgnetworks.eu.org/docs](https://sgnuikit.cdn.sgnetworks.eu.org/docs/) and a tutorial on setting up a **_Progressive Web App (PWA)_**
using **_JavaScript_** which be found at [freecodecamp.org/news](https://www.freecodecamp.org/news/build-a-pwa-from-scratch-with-html-css-and-javascript/).

## KNOWN BUGS
Expand All @@ -58,13 +55,21 @@ using **_JavaScript_** which be found at [freecodecamp.org/news](https://www.fre
## UPCOMING FEATURES
There are many features are staged to be implemented in the upcoming releases. The currently planned features awaiting to be implemented are:

1. Drag & Drop Panels/Cards
2. File (Image) upload preview (crop)
3. Themes
4. And many more...
1.
- [ ] BottomSheets (like Android Material Design)
2.
- [ ] Windows (like desktop windows)
3.
- [ ] File (Image) upload preview (crop)
4.
- [ ] Drag & Drop Panels/Cards
5.
- [ ] Themes
6. And many more...

## CONTRIBUTING
To contribute on the **_SGNUIKit Core_**, send an email on [contribute@sgnuikit.repository.sgnetworks.eu.org](mailto:contribute@sgnuikit.repository.sgnetworks.eu.org) with the following information:

To contribute on the **_SGNUIKit Core_**, send an email on [contribute@sgnuikit.cdn.sgnetworks.eu.org](mailto:contribute@sgnuikit.cdn.sgnetworks.eu.org) with the following information:

* Your real name
* Your GitHub Username
Expand All @@ -76,12 +81,11 @@ If you are selected, you'll receive an email from the core development team with
Or if you have a new feature which can be added in the `SGNUIKit Core`, just email to [rfc@sgnuikit.repository.sgnetworks.eu.org](mailto:rfc@sgnuikit.repository.sgnetworks.eu.org) with your proposal.

Or if you found a bug or error which need to be fixed create an issue at [issues](https://github.com/SGNetworksIndia/SGNUIKit/issues) or if you think you can fix the issue, report the bug to
[bug@sgnuikit.repository.sgnetworks.eu.org](mailto:bug@sgnuikit.repository.sgnetworks.eu.org) explaining the issue you found.
[bug@sgnuikit.cdn.sgnetworks.eu.org](mailto:bug@sgnuikit.cdn.sgnetworks.eu.org) explaining the issue you found.

## CREDITS

**_SGNUIKit_ is being developed by _Team SGNUIKit_ in association with _[SGNetworks](https://github.com/SGNetworksIndia/)_ and _[Indiosco Technologies Private Limited](https://github.com/Indiosco/)_
.**
**_SGNUIKit_ is being developed by _Team SGNUIKit_ in association with _[SGNetworks](https://github.com/SGNetworksIndia/)_ and _[Indiosco Technologies Private Limited](https://github.com/Indiosco/)_.**

* ### Team SGNUIKit
**Founder, Project Head & Lead Developer:** [Sagnik Ganguly](https://github.com/SagnikGanguly96) (SGN)
Expand Down
Loading

0 comments on commit 4dc1d8d

Please sign in to comment.