From fbf5bf843ca8d099d4d743749fff37d3e1ea19ba Mon Sep 17 00:00:00 2001 From: Miguel Avila Date: Mon, 14 Feb 2022 13:47:02 -0600 Subject: [PATCH] :bookmark: Documentation and Config prepared for release --- README.md | 18 +++++++++--------- config.js | 41 +++++++++++++++++++---------------------- 2 files changed, 28 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 352271d2a..be110ea42 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ - [👇 Index](#-index) - [✨ Features](#-features) - [🚀 Usage](#-usage) - - [As Home Page](#as-home-page) - - [As New Tab](#as-new-tab) + - [🏡 As Home Page](#-as-home-page) + - [➕ As New Tab](#-as-new-tab) - [🎨 Customization](#-customization) - [👋 General: Name, Image Background and Greetings](#-general-name-image-background-and-greetings) - [📐 Layouts: Bento, Lists and Buttons.](#-layouts-bento-lists-and-buttons) @@ -31,26 +31,26 @@ ## ✨ Features - **Easy configuration** file. -- **Dark/Light** mode, you can toggle them and It'll be saved in local storage.2 +- **Dark/Light** mode, you can toggle it and will be saved in local storage. - **Layouts!** to customize your experience following your workflow. - **Clock and Date** format can be set to 24 hour (default) or 12 hour. - **Greetings** are easy to modify. -- **Variables** for custom colors and font sizes in the `style.css` code. -- **Icons** all icons are from Feather Icons (Some others I made them with the Feather icons as a base) +- **Variables** for custom colors and font sizes in the `app.css` code. +- **Icons** all icons are from [Lucide icons](https://lucide.dev). - **Modular** javascript files for an easy read. ## 🚀 Usage -#### As Home Page +### 🏡 As Home Page 1. Fork this repo -2. Enable the Github Pages service `Settings > GitHub Pages > Source [master branch] > Save` +2. Enable the Github Pages service `Settings → GitHub Pages → Source [master branch] → Save` 3. Set it as Home Page: - Click the menu button. and select Options. Preferences. - Click the Home panel. - Click the menu next to Homepage and new windows and choose to show custom URLs and add your `Github Pages link` -#### As New Tab +### ➕ As New Tab You can use different Add-ons/Extensions for it @@ -79,7 +79,7 @@ To change the default name, the greetings and if you want to have an image backg ``` -> You cah change the background by substituting the `background.jpg` file in `assets` folder. +> You can change the background by substituting the `background.jpg` file in `assets` folder. ![](assets/img/backgroundImage.png) diff --git a/config.js b/config.js index ab1e3a6bf..c976d7e9f 100644 --- a/config.js +++ b/config.js @@ -16,17 +16,17 @@ const CONFIG = { openInNewTab: true, twelveHourFormat: false, - // Layout - bentoLayout: 'bento', // 'bento', 'lists', 'buttons' - // Greetings greetingMorning: 'Good morning!', greetingAfternoon: 'Good afternoon,', greetingEvening: 'Good evening,', greetingNight: 'Go to Sleep!', + // Layout + bentoLayout: 'bento', // 'bento', 'lists', 'buttons' + // Weather - weatherKey: '15fe26a8e22e4783054e3273824c5e7b', // Write here your API Key + weatherKey: 'InsertYourAPIKeyHere123456', // Write here your API Key weatherIcons: 'OneDark', // 'Onedark', 'Nord', 'Dark', 'White' weatherUnit: 'C', // 'F', 'C' language: 'en', // More languages in https://openweathermap.org/current#multi @@ -39,16 +39,13 @@ const CONFIG = { autoChangeTheme: true, // Autochabge by OS - changeThemeByOS: false, + changeThemeByOS: true, // Autochange by hour options (24hrs format, string must be in: hh:mm) - changeThemeByHour: true, + changeThemeByHour: false, hourDarkThemeActive: '18:30', hourDarkThemeInactive: '07:00', - // ╦ ╦╔╗╔╦╔═╔═╗ - // ║ ║║║║╠╩╗╚═╗ - // ╩═╝╩╝╚╝╩ ╩╚═╝ // ┌┐ ┬ ┬┌┬┐┌┬┐┌─┐┌┐┌┌─┐ // ├┴┐│ │ │ │ │ ││││└─┐ // └─┘└─┘ ┴ ┴ └─┘┘└┘└─┘ @@ -165,19 +162,19 @@ const CONFIG = { links: [ { name: 'Linkedin', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.linkedin.com', }, { name: 'Dribbble', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.dribbble.com', }, { name: 'Trello', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.trello.com', }, { name: 'Slack', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.slack.com', }, ], }, @@ -191,19 +188,19 @@ const CONFIG = { links: [ { name: 'Spotify', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.spotify.com', }, { name: 'Reddit', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.reddit.com', }, { name: 'Hashnode', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.hashnode.com', }, { name: 'Pocket', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.pocket.com', }, ], }, @@ -212,20 +209,20 @@ const CONFIG = { id: '2', links: [ { - name: 'Web', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + name: 'Front', + link: 'https://www.reddit.com/r/Frontend/', }, { name: 'Rust', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.reddit.com/r/rust/', }, { name: 'Go', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://www.reddit.com/r/golang/', }, { name: 'Repos', - link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', + link: 'https://github.com/migueravila, }, ], },