|
1 | | -<div align="center"> |
2 | | - <img src="https://raw.githubusercontent.com/apostrophecms/apostrophe/main/logo.svg" alt="ApostropheCMS logo" width="80" height="80"> |
| 1 | +# Deprecated — see our [monorepo](https://github.com/apostrophecms/apostrophe/tree/main/packages/favicon) |
3 | 2 |
|
4 | | - <h1>Favicons for ApostropheCMS</h1> |
5 | | - <p> |
6 | | - <a aria-label="Apostrophe logo" href="https://v3.docs.apostrophecms.org"> |
7 | | - <img src="https://img.shields.io/badge/MADE%20FOR%20ApostropheCMS-000000.svg?style=for-the-badge&logo=Apostrophe&labelColor=6516dd"> |
8 | | - </a> |
9 | | - <a aria-label="Join the community on Discord" href="http://chat.apostrophecms.org"> |
10 | | - <img alt="" src="https://img.shields.io/discord/517772094482677790?color=5865f2&label=Join%20the%20Discord&logo=discord&logoColor=fff&labelColor=000&style=for-the-badge&logoWidth=20"> |
11 | | - </a> |
12 | | - </p> |
13 | | -</div> |
14 | | - |
15 | | -This module allows users to edit the "favicon" (browser tab icon) of the site via the global settings of the site. |
16 | | -As such, it pairs well with the Apostrophe palette and multisite modules. |
17 | | - |
18 | | -## Compatibility |
19 | | -This version requires the latest ApostropheCMS. When adding this module to an existing project, run `npm update` to ensure all ApostropheCMS modules are up-to-date. |
20 | | - |
21 | | -## Installation |
22 | | - |
23 | | -To install the module, use the command line to run this command in an Apostrophe project's root directory: |
24 | | - |
25 | | -``` |
26 | | -npm install @apostrophecms/favicon |
27 | | -``` |
28 | | - |
29 | | -## Usage |
30 | | - |
31 | | -Configure the `@apostrophecms/favicon` module in the `app.js` file: |
32 | | - |
33 | | -```javascript |
34 | | -require('apostrophe')({ |
35 | | - shortName: 'my-project', |
36 | | - modules: { |
37 | | - '@apostrophecms/favicon': {} |
38 | | - } |
39 | | -}); |
40 | | -``` |
41 | | - |
42 | | -You do not have to do anything else. You can access the global settings of the site |
43 | | -via the "Gear" button in the upper right. Once there, select the "Favicon" tab and |
44 | | -choose your preferred image. Note that a square portion of the image is automatically |
45 | | -cropped if you do not use the cropping interface manually. |
46 | | - |
47 | | -There are no special requirements for images uploaded for this purpose, however you may |
48 | | -wish to use a PNG file in order to achieve transparency effects. |
49 | | - |
50 | | -> Browsers vary in terms of how quickly you will see the new favicon image, but a |
51 | | -> page refresh usually suffices. |
| 3 | +> We have retired this repository in favor of our monorepo. Follow the link above to jump straight to the appropriate place. Thanks! |
0 commit comments