update readme and contributing

Open-ISP · Sep 25, 2024 · 5548a66 · 5548a66
1 parent 6ef84c6
commit 5548a66
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -40,12 +40,12 @@ If you are proposing a feature:
 
 ## Get Started!
 
-Ready to contribute? Here's how to set up `package_name` for local development.
+Ready to contribute? Here's how to set up `ispypsa` for local development.
 
-1. Download a copy of `package_name` locally.
+1. Download a copy of `ispypsa` locally.
 2. Install [`rye`](https://rye.astral.sh/).
-3. Install `package_name` using `rye` by running `rye sync` in the project directory.
-4. Install the `pre-commit` git hook scripts that `package_name` uses by running the following code using `rye`:
+3. Install `ispypsa` using `rye` by running `rye sync` in the project directory.
+4. Install the `pre-commit` git hook scripts that `ispypsa` uses by running the following code using `rye`:
 
       ```console
       $ rye run pre-commit install
@@ -73,5 +73,5 @@ Before you submit a pull request, check that it meets these guidelines:
 
 ## Code of Conduct
 
-Please note that the `package_name` project is released with a
+Please note that the `ispypsa` project is released with a
 [Code of Conduct](CONDUCT.md). By contributing to this project you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -1,19 +1,11 @@
-# Template repository
-
-
-> [!IMPORTANT]  
-> Actions are disabled for this template repo. You may need to enable them again when you create a new repo from this template.
+# ISPPyPSA
 
 ## Table of contents
 
-- [How the package works](#how-the-package-works)
 - [Examples](#examples)
 - [Contributing](#contributing)
 - [License](#license)
 
-
-## How the package works
-
 ## Examples
 
 ## Contributing
@@ -24,4 +16,4 @@ Please note that this project is released with a [Code of Conduct](./CONDUCT.md)
 
 ## License
 
-`package_name` was created as a part of the [OpenISP project](https://github.com/Open-ISP). It is licensed under the terms of [GNU GPL-3.0-or-later](LICENSE) licences.
+`ISPPyPSA` was created as a part of the [OpenISP project](https://github.com/Open-ISP). It is licensed under the terms of [GNU GPL-3.0-or-later](LICENSE) licences.