Skip to content

Commit

Permalink
Merge pull request #3 from rich-iannone/v0.1.0-rc
Browse files Browse the repository at this point in the history
Release juicyjuice v0.1.0
  • Loading branch information
rich-iannone committed Nov 10, 2022
2 parents 042436e + 1033a41 commit 202b43b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 16 deletions.
7 changes: 3 additions & 4 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
^.*\.Rproj$
^\.github$
^\.Rproj\.user$
^package.json$
^package-lock.json$
^LICENSE\.md$
^js_src$
^README\.md$
^node_modules$
^package.json$
^package-lock.json$
^.*\.Rproj$
^\.Rproj\.user$
23 changes: 13 additions & 10 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
Package: juicyjuice
Title: Inline CSS Properties into HTML Tags Using 'juice'
Version: 0.0.0.9000
Authors@R:
person("Richard", "Iannone", , "riannone@me.com", c("aut", "cre"),
comment = c(ORCID = "0000-0003-3925-190X"))
Description: There are occasions where you need a piece of HTML with inlined
styles. A prime example of this is HTML email. By inlining styles you are
essentially moving the CSS and associated formatting instructions from the
Version: 0.1.0
Authors@R: c(
person("Richard", "Iannone", , "riannone@me.com", c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0003-3925-190X")),
person("Automattic", role = c("cph"), comment = "juice library"),
person("juice contributors", role = c("ctb"), comment = "juice library")
)
Description: There are occasions where you need a piece of HTML with integrated
styles. A prime example of this is HTML email. This transformation
involves moving the CSS and associated formatting instructions from the
style block in the head of your document into the body of the HTML. Many
prominent email clients require inlined styles in HTML email; otherwise a
prominent email clients require integrated styles in HTML email; otherwise a
received HTML email will be displayed without any styling. This package will
quickly and precisely perform CSS inlining when given HTML text by making
use of the JavaScript 'juice' library.
quickly and precisely perform these CSS transformations when given HTML text
and it does so by using the JavaScript 'juice' library.
License: MIT + file LICENSE
URL: https://github.com/rich-iannone/juicyjuice
BugReports: https://github.com/rich-iannone/juicyjuice/issues
Expand Down
5 changes: 5 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
The juicyjuice package as a whole is distributed under the MIT License. We also
include open source software provided by Automattic (juice,
https://github.com/Automattic/juice) which is also MIT licensed.


# MIT License

Copyright (c) 2022 juicyjuice authors
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ Will turn to this:

Why do this? An important use case is HTML email and this is mainly because of Outlook on Windows (it does not support multiple classes on elements). Furthermore CSS inlining can help preserve a decent layout in email clients that do not support embedded CSS (in `<style>` tags), or, when an email is forwarded. Here's another reason to use this: embedding HTML in 3rd-party websites.
This **R** package contains a single function, `css_inline()`, where the only input required is a string of HTML text. It uses the **juice** JavaScript library, which is (1) well-tested, (2) very performant, and (3) has lots of great features. The aformentioned function will return a string of CSS-inlined HTML.
This **R** package contains a single function, `css_inline()`, where the only input required is a string of HTML text. It uses the **juice** JavaScript library (https://github.com/Automattic/juice), which is (1) well-tested, (2) very performant, and (3) has lots of great features. The aformentioned function will return a string of CSS-inlined HTML.
## Code of Conduct
Please note that the juicyjuice project is released with a [contributor code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).<br>By participating in this project you agree to abide by its terms.
## 📄 License
**juicyjuice** is licensed under the MIT license. See the [`LICENSE.md`](LICENSE.md) file for more details.
**juicyjuice** is licensed under the MIT license. See the `LICENSE.md`](LICENSE.md) file for more details.
## 🏛️ Governance
Expand Down

0 comments on commit 202b43b

Please sign in to comment.