Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
Mateusz Duda committed May 8, 2024
1 parent 9360dd4 commit 7b345fe
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
[![npm version](https://badge.fury.io/js/scope-tags.svg)](https://www.npmjs.com/package/scope-tags)
![Auto test and deploy](https://github.com/matiduda/scope-tags/actions/workflows/test-and-deploy-to-npm.yml/badge.svg)

### Architecture diagram

![Alt text](img/architecture.png)

### Scope Tags

Command line tool for doing [change impact analysis](https://en.wikipedia.org/wiki/Change_impact_analysis) in large TypeScript projects.
- Supports integration with JIRA using a local server (1 POST endpoint required).
- Generates detailed HTML logs with every commit details
- Commits can be *verified* (eg. by a git hook) to prevent those without saved metadata
- Can be configured by the user

Currently in internal beta tests

### How to install

From the repository you want to test the package run
Expand Down Expand Up @@ -86,8 +100,4 @@ Publishing is made automatically by pushing a commit to the main branch, see [gi

- [ ] Testing approach - how each functionality should be tested?
- [ ] What actions can be performed on files?
- Adding

### Architecture diagram

![Alt text](img/architecture.png)
- Adding

0 comments on commit 7b345fe

Please sign in to comment.