Skip to content

Commit a1b14fc

Browse files
committed
[doc] update README, tag Draft-4
1 parent a88fca8 commit a1b14fc

3 files changed

Lines changed: 28 additions & 6 deletions

File tree

ChangeLog.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
Major updates are marked with a "*"
44

5+
== JData Spec Draft-4, FangQ <q.fang (a) neu.edu> ==
6+
7+
2026-04-08 [a88fca8] [schema] update json schema
8+
2026-04-08 [e0dfdd5] [doc] update header info
9+
2026-04-08 [c8bfe9f] [spellcheck] fix errors in spellcheck ci
10+
2026-04-08 [a800056] spec: extend annotation keywords, array shapes, and fix editorial issues
11+
2026-04-08 [57de727] Update introduction
12+
2026-01-26 [3f5426e] Update .wordlist.txt
13+
2026-01-22 [7f03687] Update JData_specification.md
14+
2025-12-02 [792aa4a] Merge pull request #26 from NeuroJSON/dependabot/github_actions/actions/checkout-6
15+
2025-12-02 [c708fd7] Bump actions/checkout from 5 to 6
16+
2025-08-24 [05c6e04] [schema] add json schema for jdata annotations
17+
2025-08-17 [623807d] Merge pull request #22 from NeuroJSON/dependabot/github_actions/actions/checkout-5
18+
2025-08-12 [0875682] Bump actions/checkout from 4 to 5
19+
2025-03-24 [6c96743] Merge pull request #15 from nebkat/patch-1
20+
2025-03-24 [3ca6ab5] [typo] fix typo
21+
522
== JData Spec Draft-3, FangQ <q.fang (a) neu.edu> ==
623

724
2025-02-22 [8907586] Update .wordlist.txt

NOTICE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
JData Specification
22

3-
Copyright (C) 2015,2019-2025 Qianqian Fang <q.fang at neu.edu>
3+
Copyright (C) 2015,2019-2026 Qianqian Fang <q.fang at neu.edu>
44

55
License: Apache License Version 2.0, please see LICENSE_Apache-2.0.txt for details

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,18 @@
55
We use this repository to gather feedback from the community regarding the
66
["JData Format Specification"](JData_specification.md), or JData format. Such
77
feedback is crucial to finalize this file specification and help improve
8-
it in the future once disseminated.
8+
it in the future once disseminated.
99

1010
The latest version of the JData specification can be found in the file named
1111
[JData_specification.md](JData_specification.md). The specification is written
1212
in the [Markdown format](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
1313
for convenient editing and version control.
1414

15+
The version and status of the current draft are indicated in the header of
16+
[JData_specification.md](JData_specification.md). Frozen releases are published
17+
at https://neurojson.org/jdata/. A formal JSON Schema for validating JData
18+
documents is provided in [schema/jdata_format_schema.json](schema/jdata_format_schema.json).
19+
1520
## What is JData
1621

1722
JData defines a set of **standardized**, **lightweight** and **language-neutral** annotations
@@ -27,8 +32,8 @@ JSON format BJData/UBJSON for smaller file size and faster parsing. These data f
2732
are JSON/BJData compliant and can be readily read without needing one to write their
2833
own format. There exist numerous JSON parsers, abundant BJData/UBJSON parsers, and
2934
extensively developed tools in the large JSON ecosystem - including utilities like
30-
as `jq`, JSON-native NoSQL databases, and JSON-based standards such as JSON-schema
31-
for validation, JSON-Reference and JSON-LD for data linking, JSON-Path for query etc.
35+
`jq`, JSON-native NoSQL databases, and JSON-based standards such as JSON Schema
36+
for validation, JSON Reference and JSON-LD for data linking, JSONPath for query, etc.
3237

3338
![](./images/JData_Diagram.png)
3439

@@ -48,8 +53,8 @@ draft of this file specification, including
4853
RFC (Request for comments) commit (where the entire file is removed
4954
and re-added so that every line appears in such commit). One can
5055
write short comments as well as post replies on this RFC page.
51-
- The latest RFC commit is based on **Draft 2 (version v0.8)**. Please use
52-
[this link](https://github.com/NeuroJSON/jdata/commit/6bb02c8a654938451d686c4a7c2b1b0619e7cf17) to comment.
56+
- For feedback on the current version, the [Issues section](https://github.com/NeuroJSON/jdata/issues)
57+
is the preferred channel.
5358
- To add a comment, you need to first register a github account, and then
5459
browse the above RFC page. When hovering your cursor over each line, a
5560
"plus" icon is displayed, clicking it will allow one to comment on a

0 commit comments

Comments
 (0)