readme changes

2a0989f9bdb909ab012ed5a3616c4ef34f75aff0

tucker <tucker@pangolin.lan> | Mon Sep 29 2025

readme changes
README.md:11
Before
10
11
12

13
14
15
16
17
18

19
20
21


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
## Prerequisites

1. git, which you probably already have
⁣
2. An 11ty website set up. You'll need to mmake a couple of additions to your eleventy config file.

## Installation & Setup

1. npm install this plugin

⁣
   This is not (yet) on npm. You can install it straight from this git repository, though.
   `npm install --save git+http://repos.tuckerm.us/eleventy-repo-viewer.git#deploy/0.0.1-alpha.1`

⁣
⁣
2. Add this plugin to your eleventy config.

```diff-js
+import repoViewer from 'eleventy-repo-viewer'

export default (eleventyConfig) => {
  eleventyConfig.addPlugin(repoViewer, {
    repos: {
      "My Cool Project": {
        _type: "git",
        location: "/home/me/code/cool-project",
        defaultBranch: 'main',
        branchesToPull: ['main', 'develop'],
      },
    },
    path: "/repos",
    baseUrl: "https://example.com",
  })
}
```

3. Edit `reposConfig.ts` to describe the repositories that you want to show on your site.
See below for a more detailed description of the `reposConfig.ts` file.
After
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


## Prerequisites

1. git, which you probably already have
2. An 11ty website set up. You'll need to make a couple of additions
   to your eleventy config file.

## Installation & Setup

1. npm install this plugin

   This is not (yet) on npm. You can install it straight from this git
   repository, though.
   `npm install --save git+http://repos.tuckerm.us/eleventy-repo-viewer.git#deploy/0.0.1-alpha.1`

2. Add this plugin to your eleventy config, giving it a repo configuration
   object that describes the name and location of the repositories that you
   want to display.

```diff-js
+ import repoViewer from 'eleventy-repo-viewer'

  export default (eleventyConfig) => {
+   eleventyConfig.addPlugin(repoViewer, {
+     repos: {
+       "My Cool Project": {
+         _type: "git",
+         location: "/home/me/code/cool-project",
+         defaultBranch: 'main',
+         branchesToPull: ['main', 'develop'],
+       },
+     },
+     path: "/repos",
+     baseUrl: "https://example.com",
+   })
  }
```
⁣
⁣