Author:
Hash:
Timestamp:
+50 -38 +/-1 browse
Kevin Schoon [me@kevinschoon.com]
23b66c776948ab36a9eb15342ad21808981359a1
Thu, 05 Jun 2025 12:54:19 +0000 (2 days ago)
1 | diff --git a/README.md b/README.md |
2 | index 405be98..2c178eb 100644 |
3 | --- a/README.md |
4 | +++ b/README.md |
5 | @@ -149,43 +149,51 @@ Refers to a valid SPDX identifier, see [license-list](https://spdx.org/licenses/ |
6 | Forges that allow users to configure a logo can expose this information as |
7 | an avatar for use in other applications. |
8 | |
9 | - { |
10 | - "rel": "http://webfinger.net/rel/avatar", |
11 | - "href": "https://example.org/stylized-logo.png" |
12 | - }, |
13 | + ```json |
14 | + { |
15 | + "rel": "http://webfinger.net/rel/avatar", |
16 | + "href": "https://example.org/stylized-logo.png" |
17 | + } |
18 | + ``` |
19 | |
20 | #### Homepage |
21 | |
22 | Link to an HTTP representation of the project codebase |
23 | |
24 | - { |
25 | - "rel": "http://feed-forge.org/rel/homepage", |
26 | - "href": "https://example.org/example/spartacus" |
27 | - } |
28 | + ```json |
29 | + { |
30 | + "rel": "http://feed-forge.org/rel/homepage", |
31 | + "href": "https://example.org/example/spartacus" |
32 | + } |
33 | + ``` |
34 | |
35 | #### Description |
36 | |
37 | A short text representation of the repository. |
38 | |
39 | - { |
40 | - "rel": "http://example.org/rel/description", |
41 | - "titles": { |
42 | - "en-us": "A Text Adventure Written in FORTRAN 77", |
43 | - "es": "Una Aventura de Texto Escrita en FORTRAN 77" |
44 | - } |
45 | - } |
46 | + ```json |
47 | + { |
48 | + "rel": "http://example.org/rel/description", |
49 | + "titles": { |
50 | + "en-us": "A Text Adventure Written in FORTRAN 77", |
51 | + "es": "Una Aventura de Texto Escrita en FORTRAN 77" |
52 | + } |
53 | + } |
54 | + ``` |
55 | |
56 | #### License |
57 | |
58 | A license SPDX identifier and link to the license's full text. |
59 | |
60 | - { |
61 | - "rel": "http://feed-forge.org/rel/license", |
62 | - "href": "https://example.com/example/spartacus/tree/LICENSE", |
63 | - "properties": { |
64 | - "http://feed-forge.org/ns/spdx-identifier": "GPL-2.0-or-later" |
65 | - } |
66 | - } |
67 | + ```json |
68 | + { |
69 | + "rel": "http://feed-forge.org/rel/license", |
70 | + "href": "https://example.com/example/spartacus/tree/LICENSE", |
71 | + "properties": { |
72 | + "http://feed-forge.org/ns/spdx-identifier": "GPL-2.0-or-later" |
73 | + } |
74 | + } |
75 | + ``` |
76 | |
77 | #### Chat Links |
78 | |
79 | @@ -235,18 +243,20 @@ Links to associated mailing lists, forms, etc. |
80 | |
81 | Arbitrary, free-form tags. |
82 | |
83 | - { |
84 | - "rel": "http://example.org/rel/label", |
85 | - "properties": { |
86 | - "http://feed-forge.org/ns/label": "fortran" |
87 | - } |
88 | - }, |
89 | - { |
90 | - "rel": "http://example.org/rel/label", |
91 | - "properties": { |
92 | - "label": "text-adventure" |
93 | - } |
94 | - } |
95 | + ```json |
96 | + { |
97 | + "rel": "http://example.org/rel/label", |
98 | + "properties": { |
99 | + "http://feed-forge.org/ns/label": "fortran" |
100 | + } |
101 | + }, |
102 | + { |
103 | + "rel": "http://example.org/rel/label", |
104 | + "properties": { |
105 | + "label": "text-adventure" |
106 | + } |
107 | + } |
108 | + ``` |
109 | |
110 | ### Security |
111 | |
112 | @@ -341,9 +351,11 @@ that your server implement the webfinger repository specification described |
113 | above so that repository indexes may populate their state with rich information |
114 | about code repositories hosted on your server. |
115 | |
116 | - <repository> |
117 | - <webfinger>repository:example/spartacus@example.org</webfinger> |
118 | - </repository> |
119 | + ```xml |
120 | + <repository> |
121 | + <webfinger>repository:example/spartacus@example.org</webfinger> |
122 | + </repository> |
123 | + ``` |
124 | |
125 | If the host section of the URI is included that is MUST match domain name |
126 | of the server which is providing the feed. |
127 | @@ -392,7 +404,7 @@ publish four buckets of updates per day: |
128 | 18:00:00 00:00:00 |
129 | |
130 | For example if the current time is 2021-03-05 13:00:55 UTC you could use |
131 | - the following heuristic to return a summary of repository events from the |
132 | + the following example to return a summary of repository events from the |
133 | previous time bucket. |
134 | |
135 | now = time.now() |