Skip to content

Commit e1c55ce

Browse files
docs: update docs to add synchronizeReadingList
input option values in readme and example md
1 parent d8c30ab commit e1c55ce

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

Examples.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ jobs:
132132
![create reading list](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/d13f89a7-7999-4dab-9efb-12094918d078)
133133

134134

135-
## Reading List with read time
135+
## Reading List with read time & synchronization with DEV.
136136

137137
> Explanation
138138

139-
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`).
139+
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.
140140

141141
> Workflow code
142142

@@ -166,6 +166,7 @@ jobs:
166166
readingList: true
167167
outputDirReading: "read" # this will save reading list in read/Readme.md
168168
readTime: true
169+
synchronizeReadingList: true
169170
```
170171

171172
> Output

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Your sentences are clear, but here are some minor grammar adjustments for clarit
1717
- 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.
1818
- All articles and the reading list will be fetched regardless of the total number.
1919
- If you update an article on DEV, it will be automatically updated here the next time the workflow runs.
20+
- 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.
2021

2122
---
2223

@@ -75,6 +76,7 @@ Various inputs are defined to let you configure the action:
7576
| `mustIncludeTags` | To create a reading list to include this tag prioritizing over excludeTags. Use commas to separate if there are multiple tags. | `''` | `No` |
7677
| `branch` | The git branch to use for these process. | `'main'` | `No` |
7778
| `conventionalCommits` | To use conventional commit message standards. | `'true'` | `No` |
79+
| `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` |
7880

7981
<br>
8082

@@ -95,8 +97,6 @@ Suppose we have an article with tags: `['react', 'javascript', 'frontend', 'tuto
9597
- If `excludeTags` is 'backend' and `mustIncludeTags` is 'typescript'. The article is included because it does not have the `backend` tag.
9698
- These cases will work for multiple tags, and `mustIncludeTags` will only work if `excludeTags` is provided.
9799

98-
> 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.
99-
100100
---
101101

102102
## 🤝 How to Contribute?
@@ -130,7 +130,7 @@ The scripts and documentation in this project are released under the <a href="./
130130
<img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white" /> <img src="https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white" />
131131
<img src="https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=Postman&logoColor=white" />
132132

133-
- I've used Forem v1 APIs. You can refer to the [docs](https://developers.forem.com/api/v1).
133+
- I've used Forem v1 APIs for building DevtoGithub. You can refer to the [docs](https://developers.forem.com/api/v1).
134134

135135
---
136136

0 commit comments

Comments
 (0)