From e1c55ce66075e310c2a9dd96b4dc3345d8edb63b Mon Sep 17 00:00:00 2001 From: Anmol Baranwal Date: Tue, 5 Mar 2024 01:01:22 +0530 Subject: [PATCH] docs: update docs to add synchronizeReadingList input option values in readme and example md --- Examples.md | 5 +++-- README.md | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/Examples.md b/Examples.md index f4e83b7..bc1f9af 100644 --- a/Examples.md +++ b/Examples.md @@ -132,11 +132,11 @@ jobs: ![create reading list](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/d13f89a7-7999-4dab-9efb-12094918d078) -## Reading List with read time +## Reading List with read time & synchronization with DEV. > Explanation -This will stop saving your articles since `saveArticles` is set to `false` (default is `true`). It will create your reading list with the articles in a structured way. You can change which directory you want using `outputDirReading`. For instance, the below workflow will save your articles in the `read` directory by adding your info in a `README`. It will add a reading time with the articles when `readTime` is set to `true` (default is `false`). +This will stop saving your articles since `saveArticles` is set to `false` (default is `true`). It will create your reading list with the articles in a structured way. You can change which directory you want using `outputDirReading`. For instance, the below workflow will save your articles in the `read` directory by adding your info in a `README`. It will add a reading time with the articles when `readTime` is set to `true` (default is `false`). Setting `synchronizeReadingList` to `true` will synchronize your reading list from DEV, removing any article from your reading list on DEV will also remove it from the readme here. > Workflow code @@ -166,6 +166,7 @@ jobs: readingList: true outputDirReading: "read" # this will save reading list in read/Readme.md readTime: true + synchronizeReadingList: true ``` > Output diff --git a/README.md b/README.md index 897c570..028aa21 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Your sentences are clear, but here are some minor grammar adjustments for clarit - I've included [custom logic](https://github.com/Anmol-Baranwal/DevtoGitHub?tab=readme-ov-file#the-concept-of-excludetags-and-mustincludetags) based on tags to provide you with more flexibility in managing your reading list. - All articles and the reading list will be fetched regardless of the total number. - If you update an article on DEV, it will be automatically updated here the next time the workflow runs. +- You can synchronize your reading list from DEV. For instance, if you remove any article from the reading list on DEV, then it will also be removed in the reading list in the readme. --- @@ -75,6 +76,7 @@ Various inputs are defined to let you configure the action: | `mustIncludeTags` | To create a reading list to include this tag prioritizing over excludeTags. Use commas to separate if there are multiple tags. | `''` | `No` | | `branch` | The git branch to use for these process. | `'main'` | `No` | | `conventionalCommits` | To use conventional commit message standards. | `'true'` | `No` | +| `synchronizeReadingList` | To synchronize the reading list from DEV. Removing an article from the reading list on DEV will also remove it from the repository. | `'false'` | `No` |
@@ -95,8 +97,6 @@ Suppose we have an article with tags: `['react', 'javascript', 'frontend', 'tuto - If `excludeTags` is 'backend' and `mustIncludeTags` is 'typescript'. The article is included because it does not have the `backend` tag. - These cases will work for multiple tags, and `mustIncludeTags` will only work if `excludeTags` is provided. -> Please note that even if you remove a article from your reading list on DEV, it's isn't deleted from this repository. I'm going to solve this in the future release. - --- ## 🤝 How to Contribute? @@ -130,7 +130,7 @@ The scripts and documentation in this project are released under the -- I've used Forem v1 APIs. You can refer to the [docs](https://developers.forem.com/api/v1). +- I've used Forem v1 APIs for building DevtoGithub. You can refer to the [docs](https://developers.forem.com/api/v1). ---