Update docs

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
-<!-- <START NEW CHANGELOG ENTRY> -->
+All notable changes to this project will be documented in this file.
 
-<!-- <END NEW CHANGELOG ENTRY> -->
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- First implementation of a simple notification emiter whenever the resource
+  usage gets into warning

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, Enol Fernandez
+Copyright (c) 2024, EGI Foundation 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,8 +1,8 @@
-# resource_warning
+# notebooks-resource-warning
 
-[![Github Actions Status](https://github.com/enolfc/resource-warnings/workflows/Build/badge.svg)](https://github.com/enolfc/resource-warnings/actions/workflows/build.yml)
+[![Github Actions Status](https://github.com/EGI-Federation/notebooks-resource-warnings/workflows/Build/badge.svg)](https://github.com/EGI-Federation/notebooks-resource-warnings/actions/workflows/build.yml)
 
-A JupyterLab extension.
+A JupyterLab extension that shows a notification whenever the usage of memory goes into `warn` status (as provided by the [Jupyter Resource Usage extension](https://github.com/jupyter-server/jupyter-resource-usage)
 
 ## Requirements
 
@@ -13,15 +13,15 @@ A JupyterLab extension.
 To install the extension, execute:
 
 ```bash
-pip install resource_warning
+pip install notebooks-resource-warning
 ```
 
 ## Uninstall
 
 To remove the extension, execute:
 
 ```bash
-pip uninstall resource_warning
+pip uninstall notebooks-resource-warning
 ```
 
 ## Contributing
@@ -36,7 +36,7 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the resource_warning directory
+# Change directory to the notebooks-resource-warning directory
 # Install package in development mode
 pip install -e "."
 # Link your development version of the extension with JupyterLab
@@ -65,7 +65,7 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
-pip uninstall resource_warning
+pip uninstall notebooks-resource-warning
 ```
 
 In development mode, you will also need to remove the symlink created by `jupyter labextension develop`

RELEASE.md

@@ -1,4 +1,4 @@
-# Making a new release of resource_warning
+# Making a new release of notebooks-resource-warning
 
 The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
 

package.json

@@ -1,15 +1,15 @@
 {
     "name": "resource_warning",
     "version": "0.1.0",
-    "description": "A JupyterLab extension.",
+    "description": "A JupyterLab extension that shows a notification when reaching warning level of resource consumption (memory).",
     "keywords": [
         "jupyter",
         "jupyterlab",
         "jupyterlab-extension"
     ],
-    "homepage": "https://github.com/enolfc/resource-warnings",
+    "homepage": "https://github.com/EGI-Federation/resource-warnings",
     "bugs": {
-        "url": "https://github.com/enolfc/resource-warnings/issues"
+        "url": "https://github.com/EGI-Federation/resource-warnings/issues"
     },
     "license": "BSD-3-Clause",
     "author": {
@@ -26,7 +26,7 @@
     "style": "style/index.css",
     "repository": {
         "type": "git",
-        "url": "https://github.com/enolfc/resource-warnings.git"
+        "url": "https://github.com/EGI-Federation/resource-warnings.git"
     },
     "scripts": {
         "build": "jlpm build:lib && jlpm build:labextension:dev",
@@ -55,6 +55,7 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
+        "@jupyter-server/resource-usage": "^1.1.0",
         "@jupyterlab/application": "^4.0.0"
     },
     "devDependencies": {