Release 1.0.0

dymmond · Dec 22, 2023 · abd3300 · abd3300
1 parent 614c43d
commit abd3300
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 18 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -42,7 +42,7 @@ To develop for Dymmond Settings, create a fork of the [Dymmond Settings reposito
 After, clone your fork with the follow command replacing `YOUR-USERNAME` wih your GitHub username:
 
 ```shell
-$ git clone https://github.com/YOUR-USERNAME/dymmond_settings
+$ git clone https://github.com/YOUR-USERNAME/dymmond-settings
 ```
 
 ### Install the project dependencies
@@ -73,14 +73,10 @@ Because Dymmond Settings uses pytest, any additional arguments will be passed. M
 
 For example, to run a single test_script:
 
-```shell
-$ scripts/test tests/test_apiviews.py
-```
-
 To run the linting, use:
 
 ```shell
-$ scripts/format
+$ scripts/lint
 ```
 
 ### Documentation

diff --git a/docs/index.md b/docs/index.md
@@ -20,6 +20,8 @@
 
 ---
 
+**Documentation**: [https://settings.dymmond.com](https://settings.dymmond.com) 📚
+
 **Source Code**: [https://github.com/dymmond/dymmond-settings](https://github.com/dymmond/dymmond-settings)
 
 **The official supported version is always the latest released**.

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,9 +1,6 @@
 # Release Notes
 
-## 0.1.0
+## 1.0.0
 
-### Added
-
-### Changed
-
-### Fixed
+Initial release containing all the information about
+the `dymmond-settings` package.
diff --git a/docs/sponsorship.md b/docs/sponsorship.md
@@ -2,9 +2,6 @@
 
 Do you like **Dymmond Settings** and would like to help Dymmond Settings, other user and the author?
 
-## 🐦 Follow Dymmond Settings on Twitter
-
-
 ## ⭐ Star **Dymmond Settings** on GitHub
 
 Giving a star to Dymmond Settings is very simple and helps promoting the work across the developers around the world.
@@ -24,6 +21,11 @@ interesting to you.
 
 ## 💬 Join the official Dymmond Settings discord channel
 
+Our official chat is on discord, we find it very useful and free for people to discuss issues, helping and contributing
+in a more organised manner.
+
+<a href="https://discord.gg/eMrM9sWWvu" target="_blank">Esmerald discord channel</a>. Join us! 🗸
+
 ## 🔥 Sponsor the author
 
 The author built this framework with all of his heart and dedication and will continue to do it so but that also

diff --git a/dymmond_settings/__init__.py b/dymmond_settings/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "1.0.0"
 
 from .base import Settings
 from .conf import settings

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,8 +8,8 @@ theme:
  language: en
  palette:
  - scheme: "default"
- primary: "purple"
- accent: "amber"
+ primary: "light blue"
+ accent: "blue"
  media: "(prefers-color-scheme: light)"
  toggle:
  icon: "material/lightbulb"