Updated readme & added changelog

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+V1: init Primo Startup Browsing Page.
+V2: change the name to Your Browsing Homepage, major update.
+V2.1.0: Added dark & light mode, added auto-focus, added on escape pressed clear input, some update.
+V2.1.1: Uploaded to Google Chrome Store and Mozilla Firefox Store.
+V2.2.0: New websites, selectable search engine, some updates.
+V2.3.0: Style edited, tooltip added, multiple custom versions, structure updated.
+V2.3.1: little bug fixed in version.
+V2.3.2: auto-detect mode added, added some websites, new search engines added, ads removed, fix keycode deprecated, changed the file structure.
+V2.3.3: added bluesky & changed twitter to x.

README.md

@@ -1,75 +1,87 @@
-# Primo Startup Browsing Page [Your Browsing Homepage]
-Your gate to the internet
+# Your Browsing Homepage (formerly Primo Startup Browsing Page)
 
+A start/home page for your favorite websites.
 
+## Why?
 
-## Why Primo Startup Browsing Page Script?
-- 100% Open-source and free.
-- Shortcut for your favorite websites.
-- Your favourite and most used websites in one page.
+- Free and open-source.
+- Local and offline.
+- No hidden scripts.
+- Shortcut for your favorite websites, meaning your favorite and most used websites in one page.
 - Native/Pure JavaScript.
 - Files to edit/manage your favorite websites.
 - One file to add a new website.
-- Easy to customize by yourself without any programming knowledge.
-- No hidden scripts.
+- Easy to customize.
 - Dark & Light mode.
 - Multiple search engines.
 - Multiple custom versions.
 
+## Live Preview
 
-
-## Live Preview:
-https://m-primo.github.io/psbp/index.html
-
-
+<https://m-primo.github.io/psbp/index.html>
 
 ## Google Chrome Extension
-https://chrome.google.com/webstore/detail/your-browsing-homepage/gankljibcichebamdgagnnncmnoacdmi
 
+**NOT UP-TO-DATE**
 
+<https://chrome.google.com/webstore/detail/your-browsing-homepage/gankljibcichebamdgagnnncmnoacdmi>
 
 ## Mozilla Firefox Extension
-https://addons.mozilla.org/en-US/firefox/addon/your-browsing-homepage/
 
+**NOT UP-TO-DATE**
 
+<https://addons.mozilla.org/en-US/firefox/addon/your-browsing-homepage/>
+
+## Usage
+
+### Add Sites
 
-## Usage:
-### Add Sites:
 Open [userSites.js](userSites.js), then add a code like the syntax bellow:
+
 ```javascript
 new Site("Website Name", "full url with http or https", "iconname.ext", "Description (you can leave it empty)");
 ```
+
 For example, if you want to add Blogger:
+
 ```javascript
 new Site("Blogger", "https://blogger.com", "b.png");
 ```
+
 **DO NOT FORGET TO ADD THE IMAGE IN THIS DIRECTORY: `img/site`.**
 
 To add an external icon, just add `true` at the end:
 
 For example:
+
 ```javascript
 new Site("Website Name", "full url with http or https", "http://www.example.com/iconname.ext", "Description (you can leave it empty)", true);
 ```
-Just replace `http://www.example.com/iconname.ext` with the image url.
 
+Just replace `http://www.example.com/iconname.ext` with the actual image url.
+
+### Add Versions
 
-### Add Versions:
 First: Create your userSites script file, and the name should be like this: `version_userSites.js`.
 
 For example, if you want to name your version `personal`, so the script file name should be: `personal_userSites.js`.
 
-Second: To show the homepage with your created version, you should add `?version=version` in the URL bar.
-For the above example, you should add `?version=personal` in the URL bar, and it'll load your websites you added in `personal_userSites.js` file.
+Second: Add the websites you want in that newly created file, just like in `userSites.js`.
 
+Finally: To access the homepage with your created version, you should add `?version=version` in the URL bar.
 
+For the above example, you should add `?version=personal` in the URL bar, and it'll load your websites you added in `personal_userSites.js` file. In other words, if your version is `personal` and the current homepage link is `https://example.com`, you can access it like this: `https://example.com?version=personal`.
 
-## Contributing
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+## Changelog
 
+[Changelog](CHANGELOG.md)
 
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 ## License
+
 [MIT](https://choosealicense.com/licenses/mit/)
 
-[License Details](LICENSE)
+[License Details](LICENSE)