From 4a0936001acb055f4110a6d5d9d5b8342b87dd70 Mon Sep 17 00:00:00 2001 From: Jan Dvorak Date: Sat, 23 Sep 2023 15:47:39 +0200 Subject: [PATCH] Update readme --- .all-contributorsrc | 4 +- .versions | 89 +++++++++++++++++++++++---------------------- README.md | 41 +++++++++++---------- package.js | 2 +- package.json | 2 +- 5 files changed, 70 insertions(+), 68 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 0328ef7..ba9077c 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -18,8 +18,7 @@ "contributions": [ "code", "doc", - "ideas", - "maintenance" + "ideas" ] }, { @@ -29,7 +28,6 @@ "profile": "https://github.com/sebakerckhof", "contributions": [ "code", - "maintenance", "review", "test" ] diff --git a/.versions b/.versions index 3ca7aca..edbf3f9 100644 --- a/.versions +++ b/.versions @@ -1,69 +1,70 @@ -allow-deny@1.1.0 -autoupdate@1.6.0 -babel-compiler@7.4.2 -babel-runtime@1.4.0 +allow-deny@1.1.1 +autoupdate@1.8.0 +babel-compiler@7.10.4 +babel-runtime@1.5.1 base64@1.0.12 binary-heap@1.0.11 blaze@2.1.9 blaze-tools@1.0.10 -boilerplate-generator@1.6.0 -caching-compiler@1.2.1 +boilerplate-generator@1.7.1 +caching-compiler@1.2.2 caching-html-compiler@1.0.7 -callback-hook@1.2.0 -check@1.3.1 +callback-hook@1.5.1 +check@1.3.2 coffeescript@1.0.17 cultofcoders:mocha@2.4.6 -ddp@1.4.0 -ddp-client@2.3.3 +ddp@1.4.1 +ddp-client@2.6.1 ddp-common@1.4.0 -ddp-server@2.3.0 +ddp-server@2.6.2 deps@1.0.12 -diff-sequence@1.1.1 -dynamic-import@0.5.1 -ecmascript@0.13.2 -ecmascript-runtime@0.7.0 -ecmascript-runtime-client@0.9.0 -ecmascript-runtime-server@0.8.0 -ejson@1.1.1 -fetch@0.1.1 -geojson-utils@1.0.10 +diff-sequence@1.1.2 +dynamic-import@0.7.3 +ecmascript@0.16.7 +ecmascript-runtime@0.8.1 +ecmascript-runtime-client@0.12.1 +ecmascript-runtime-server@0.11.0 +ejson@1.1.3 +fetch@0.1.3 +geojson-utils@1.0.11 html-tools@1.0.11 htmljs@1.0.11 -id-map@1.1.0 -inter-process-messaging@0.1.0 +id-map@1.1.1 +inter-process-messaging@0.1.1 jquery@1.11.11 -local-test:reywood:publish-composite@1.7.3 -logging@1.1.20 -meteor@1.9.3 -minimongo@1.4.5 -modern-browsers@0.1.4 -modules@0.14.0 -modules-runtime@0.11.0 -mongo@1.7.0 -mongo-decimal@0.1.1 +local-test:reywood:publish-composite@1.8.0 +logging@1.3.2 +meteor@1.11.3 +minimongo@1.9.3 +modern-browsers@0.1.9 +modules@0.19.0 +modules-runtime@0.13.1 +mongo@1.16.7 +mongo-decimal@0.1.3 mongo-dev-server@1.1.0 -mongo-id@1.0.7 -npm-mongo@3.2.0 +mongo-id@1.0.8 +npm-mongo@4.16.0 observe-sequence@1.0.16 ordered-dict@1.1.0 practicalmeteor:chai@2.1.0_1 practicalmeteor:loglevel@1.2.0_2 practicalmeteor:mocha-core@1.0.1 practicalmeteor:sinon@1.14.1_2 -promise@0.11.2 -random@1.1.0 -reactive-var@1.0.11 -reload@1.3.0 +promise@0.12.2 +random@1.2.1 +react-fast-refresh@0.2.7 +reactive-var@1.0.12 +reload@1.3.1 retry@1.1.0 -reywood:publish-composite@1.7.3 -routepolicy@1.1.0 -socket-stream-client@0.2.2 +reywood:publish-composite@1.8.0 +routepolicy@1.1.1 +socket-stream-client@0.5.1 spacebars@1.0.13 spacebars-compiler@1.1.3 templating@1.1.14 templating-tools@1.1.2 tmeasday:test-reporter-helpers@0.2.1 -tracker@1.2.0 -underscore@1.0.10 -webapp@1.7.5 -webapp-hashing@1.0.9 +tracker@1.3.2 +underscore@1.0.13 +webapp@1.13.5 +webapp-hashing@1.1.1 diff --git a/README.md b/README.md index 94b0fb5..ed1c2e1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -meteor-publish-composite -======================== +# meteor-publish-composite + +`publishComposite(...)` provides a flexible way to publish a set of related documents from various collections using a reactive join. This makes it easy to publish a whole tree of documents at once. The published collections are reactive and will update when additions/changes/deletions are made. + +## Project [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) ![GitHub](https://img.shields.io/github/license/Meteor-Community-Packages/meteor-publish-composite) @@ -10,9 +13,6 @@ meteor-publish-composite [![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-) - -`publishComposite(...)` provides a flexible way to publish a set of related documents from various collections using a reactive join. This makes it easy to publish a whole tree of documents at once. The published collections are reactive and will update when additions/changes/deletions are made. - This project differs from many other parent/child relationship mappers in its flexibility. The relationship between a parent and its children can be based on almost anything. For example, let's say you have a site that displays news articles. On each article page, you would like to display a list at the end containing a couple of related articles. You could use `publishComposite` to publish the primary article, scan the body for keywords which are then used to search for other articles, and publish these related articles as children. Of course, the keyword extraction and searching are up to you to implement. *Found a problem with this package? [See below for instructions on reporting](#reporting-issuesbugs).* @@ -297,23 +297,26 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d - - - - - - - - - - - - - + + + + + + + + + + + + + + +

Sean Dwyer

💻 📖 🤔 🚧

Seba Kerckhof

💻 🚧 👀 ⚠️

Richard Lai

🐛 💻

Simon Fridlund

💻

Patrick Lewis

💻

nabiltntn

💻

Krzysztof Czech

💻

Jan Dvorak

💻 📖 🚇 🚧 🔧

Koen [XII]

💻
Sean Dwyer
Sean Dwyer

💻 📖 🤔
Seba Kerckhof
Seba Kerckhof

💻 👀 ⚠️
Richard Lai
Richard Lai

🐛 💻
Simon Fridlund
Simon Fridlund

💻
Patrick Lewis
Patrick Lewis

💻
nabiltntn
nabiltntn

💻
Krzysztof Czech
Krzysztof Czech

💻
Jan Dvorak
Jan Dvorak

💻 📖 🚇 🚧 🔧
Koen [XII]
Koen [XII]

💻
- + + This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/package.js b/package.js index 1988cd5..a25bff8 100644 --- a/package.js +++ b/package.js @@ -1,7 +1,7 @@ /* globals Package */ Package.describe({ name: 'reywood:publish-composite', - summary: 'Publish a set of related documents from multiple collections with a reactive join', + summary: 'Publish a set of related documents from multiple collections with a reactive join.', version: '1.8.0', git: 'https://github.com/Meteor-Community-Packages/meteor-publish-composite' }) diff --git a/package.json b/package.json index c597fbf..c63f1ca 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "scripts": { "test": "npm run lint && meteor test-packages ./ --driver-package cultofcoders:mocha", "lint": "./node_modules/.bin/standard --fix", - "publish": "meteor npm i && npm prune --production && meteor publish && meteor npm i", + "publish": "npm prune --production && meteor publish && meteor npm i", "all-contributors": "./node_modules/.bin/all-contributors", "all-contributors-generate": "./node_modules/.bin/all-contributors generate" },