diff --git a/README.md b/README.md index 73be689..517c1d6 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,143 @@  -LittleLink Extended is an addon repository for [LittleLink](https://github.com/sethcottle/littlelink). This repository welcomes more niche services that aren't as globally or regionally popular as required by the core LittleLink repo. Users will be able to import the entirety of these extensions into their fork of LittleLink or selectively add services from it by copy and pasting what they'd like to use into their `brands.css` file and `icons` folders. +**LittleLink Extended** is an add-on repository for [LittleLink](https://github.com/sethcottle/littlelink). It welcomes more niche or region-specific services that aren’t quite popular enough for the core LittleLink repo. By importing this extension, you can expand your LittleLink setup with additional brands and icons. You can either import everything or selectively copy only the pieces you need. -### 📂 Getting Started +--- -You will need to fork or download a copy of the original [LittleLink project](https://github.com/sethcottle/littlelink) to use these extended brands in tandem with. +## 📂 Getting Started -#### ⬇️ Import the Extended CSS +To use **LittleLink Extended**, you’ll need a copy of the original [LittleLink project](https://github.com/sethcottle/littlelink). Fork or download that repository first. -Copy and paste the `brands-extended.css` file that is in the `css` folder of this repository into the `css` folder that is in your copy of the [LittleLink project](https://github.com/sethcottle/littlelink). Your folder should look a little something like this after: +Then: - +1. **Clone or download** this **LittleLink Extended** repo. +2. **Copy the necessary files** (CSS and icons) into your LittleLink project. +3. **Reference the new CSS** in your `index.html`. -#### ⬇️ Import the Extended Icons +### 1. Import the Extended CSS -Copy and paste the `icons-extended` folder that is in the `images` folder of this repository into the `images` folder in your copy of the [LittleLink project](https://github.com/sethcottle/littlelink). Your folder should look a little something like this after: +In this repo’s `css` folder, you’ll find **`brands-extended.css`**. Copy that file into the `css` folder of your LittleLink project. Your folder structure should look something like this afterward: - +``` +littlelink +│ +├── css +│ ├── reset.css +│ ├── style.css +│ ├── brands.css +│ └── brands-extended.css ← (new) +│ +└── images + └── icons +``` -When access iconography, you'll reference the folder `images/icons-extended/...` to refence the icons included with LittleLink Extended. +### 2. Import the Extended Icons -#### ✏️ Edit `index.html` to include the Extended CSS +In this repo’s `images` folder, you’ll find a folder named **`icons-extended`**. Copy that entire folder into the `images` folder of your LittleLink project. Your structure might then look like: -Open `index.html` in your copy of the [LittleLink project](https://github.com/sethcottle/littlelink), the first section of the HTML has a `
` section. Find the CSS segment `` and underneath it, add ``. It should look something like this: +``` +littlelink +│ +├── css +│ ├── ... +├── images +│ ├── avatar.png +│ ├── icons +│ └── icons-extended ← (new) +└── ... +``` +When you need to reference an extended icon, you’ll do so via `images/icons-extended/...`. - +### 3. Edit `index.html` to Include the Extended CSS -### 👍 That's it! +Open your LittleLink project’s `index.html`. In the `` section, find the line that references `brands.css`: -View the original [LittleLink repo](https://github.com/sethcottle/littlelink). \ No newline at end of file +```html + +``` + +Beneath it, add a line for the extended CSS: + +```html + +``` + +It should look something like: + +```html + + + + +``` + +That’s all you need to pull in the extended brand styles. + +--- + +## 👍 That’s It! + +At this point, you’ve successfully imported **LittleLink Extended**. To see how to use the newly added buttons, simply reference them in your `index.html` or `preview.html` by using their associated classes (e.g., `button-anilist`, `button-bereal`, etc.). + +For more information on the original LittleLink project, check out the [LittleLink repo](https://github.com/sethcottle/littlelink). + +--- + +# Extended Modules + +## Sensitive Content Warning + +In addition to extended brands, this repository includes an **optional module** for adding **“Sensitive Content”** warnings. This module lets you display a slide-down panel warning users about potentially sensitive or age-restricted content. Each panel can include a **“Continue”** button that opens a custom link, set entirely in your HTML. + +