Skip to content

Commit 0b1092e

Browse files
committed
fix: update README.md
1 parent fdda390 commit 0b1092e

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# git-users-extractor
1+
# src-fingerprint
22

33
## Introduction
44

5-
The purpose of this package is to extract all git user information of your developers from your hosted source version control system
5+
The purpose of this package is to extract some git related information (all files sha, also commits sha) from your hosted source version control system
66

77
It supports 3 main on premise version control service:
88

@@ -44,17 +44,17 @@ All the git information can be found inside commit that are located inside git r
4444
Our tree element step are the following:
4545
* Collect all repositories URL from the company.
4646
* Clone them with the appropriate authentication.
47-
* Clone them and iterate over commits to extract git config information.
48-
* Store this information in a json file.
47+
* Run git commands to extract the information we need on each repository.
48+
* Gather data and store this information in a json file.
4949
5050
### Implementation
5151
The root package is the abstract implementation of the extractor. It contains a Cloner, that clones a git repository.
52-
It contains a Pipeline that extracts git information for every commit, of every repository of an organization.
52+
It contains a Pipeline that extracts git information for every git artifact (currently a git file but we could support commit), of every repository of an organization.
5353
5454
The github package contains the implementation of the Github Provider.
5555
The gitlab package contains the implementation of the Gitlab Provider.
5656
57-
The cmd/guser-extractor package contains the binary code. It reads from CLI and environment the configuration and run the Pipeline on an organization.
57+
The cmd/dna-collector package contains the binary code. It reads from CLI and environment the configuration and run the Pipeline on an organization.
5858
5959
### Library we use
6060
@@ -72,7 +72,3 @@ The cmd/guser-extractor package contains the binary code. It reads from CLI and
7272
* Channels are cheap. Complex design overloading semantics isn't.
7373

7474

75-
### Notes eric
76-
77-
* We want to add more extractors -> We need to extract file shas
78-
* We will add more analyzer -> From the commits we want to get commits shas

0 commit comments

Comments
 (0)