[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/tomelr 000067cf7d 14/84: chore(readme): Update
From: |
ELPA Syncer |
Subject: |
[elpa] externals/tomelr 000067cf7d 14/84: chore(readme): Update |
Date: |
Tue, 3 May 2022 09:58:08 -0400 (EDT) |
branch: externals/tomelr
commit 000067cf7db0a836d9c312a1ba78f25d8d667398
Author: Kaushal Modi <kaushal.modi@gmail.com>
Commit: Kaushal Modi <kaushal.modi@gmail.com>
chore(readme): Update
---
README.org | 59 ++++++++++++++++++++++++++++++++++++-----------------------
1 file changed, 36 insertions(+), 23 deletions(-)
diff --git a/README.org b/README.org
index 6c03b754b0..b3b4c0ae91 100644
--- a/README.org
+++ b/README.org
@@ -10,10 +10,46 @@
* Installation
Clone this repo, have ~tomelr.el~ in the ~load-path~ and ~(require
'tomelr)~.
+* Credit
+This library started off by extracting the JSON Encoding pieces from
+the Emacs core library
[[https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/json.el][*json.el*]].
+
+It will then be gradually refactored so that it meets the
+specification defined below.
* Specification and Conversion Examples
+[[https://scripter.co/defining-tomelr/][Companion blog post]]
+
Below examples are shown on how S-expressions get translated to
various TOML object types.
** Scalars
+*** DONE Boolean
+CLOSED: [2022-04-28 Thu 16:48]
+https://toml.io/en/v1.0.0#boolean
+**** S-expression
+#+begin_src emacs-lisp :eval no :noweb-ref scalar-boolean
+'((bool1 . t)
+ (bool2 . :false))
+#+end_src
+**** TOML
+#+begin_src emacs-lisp :noweb yes :exports results
+(tomelr-encode
+ <<scalar-boolean>>)
+#+end_src
+
+#+RESULTS:
+: bool1 = true
+: bool2 = false
+**** JSON Reference
+#+begin_src emacs-lisp :noweb yes :exports results
+(json-encode-pretty
+ <<scalar-boolean>>)
+#+end_src
+
+#+RESULTS:
+: {
+: "bool1": true,
+: "bool2": false
+: }
*** String
https://toml.io/en/v1.0.0#string
**** S-expression
@@ -108,29 +144,6 @@ flt7 = 6.626e-34
: "flt6": -0.02,
: "flt7": 6.626e-34
: }
-*** Boolean
-https://toml.io/en/v1.0.0#boolean
-**** S-expression
-#+begin_src emacs-lisp :eval no :noweb-ref scalar-boolean
-'((bool1 . t)
- (bool2 . :false))
-#+end_src
-**** TOML
-#+begin_src toml
-bool1 = true
-bool2 = false
-#+end_src
-**** JSON Reference
-#+begin_src emacs-lisp :noweb yes :exports results
-(json-encode-pretty
- <<scalar-boolean>>)
-#+end_src
-
-#+RESULTS:
-: {
-: "bool1": true,
-: "bool2": false
-: }
*** Date + Time with Offset
https://toml.io/en/v1.0.0#offset-date-time
**** S-expression
- [elpa] externals/tomelr b2ba4c46b5 82/84: refactor: Minor code reorg, (continued)
- [elpa] externals/tomelr b2ba4c46b5 82/84: refactor: Minor code reorg, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr d86fd721ce 63/84: fix: Compatibility for emacs 26.3, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr a1fa47379e 84/84: chore: Add CHANGELOG generated using git cliff tool, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr ae983711be 78/84: fix: Auto-stringify symbols like 1.10.1, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 61397410af 01/84: Initial empty commit, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 846676a172 06/84: feat: Add plist example, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 8bc506af5a 02/84: Add s-exp->toml examples and spec, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 7d8d41f15b 19/84: feat: Encode to multi-line TOML string automatically, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 0ba5f2ff69 24/84: chore(readme): Move mixed type array example to the 'medley' example, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr ca9245038a 35/84: fix: Attempt to make tomelr--toml-table-p more robust, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 000067cf7d 14/84: chore(readme): Update,
ELPA Syncer <=
- [elpa] externals/tomelr 69217d47a6 22/84: feat: Skip converting keys whose values are nil, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr af40c0b40f 11/84: fix: Require subr-x for older Emacs versions, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 060c38b934 16/84: chore(readme): Limit up to 3 levels of headings for Org exports, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 20bf9e6c54 12/84: chore(doc): Add GHA and license badges, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr f37841cc78 25/84: test: Add test for TOML Array of Arrays, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr cedb75df72 29/84: feat: Support basic TOML tables, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 91800b26b8 21/84: feat: Recognize RFC 3339 formatted date-time + offset, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 83e924559e 13/84: chore(doc): Fix typo, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr 98c9b8c1fc 26/84: fix: Use `=` and `length` separately instead of `length=`, ELPA Syncer, 2022/05/03
- [elpa] externals/tomelr c0962ba15f 33/84: fix: Don't run plist to TOML conversion test on emacs 26.3 and older, ELPA Syncer, 2022/05/03