Skip to content

Commit 4b40183

Browse files
authored
readme: some fixes/improvements (#1252)
* readme: some fixes/improvements * typo
1 parent 6413f1e commit 4b40183

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,32 +84,32 @@ $ git clone http://josh/central.git:workspace=workspaces/project1.git
8484

8585
With everything stored in one repo, CI/CD systems only need to look into one source for each particular
8686
deliverable.
87-
However in traditional monorepo environments dependency mangement is handled by the build system.
87+
However, in traditional monorepo environments, dependency management is handled by the build system.
8888
Build systems are usually tailored to specific languages and need their input already checked
8989
out on the filesystem.
9090
So the question:
9191

92-
> "What deliverables are affected by a given commit and need to be rebuild?"
92+
> "What deliverables are affected by a given commit and need to be rebuilt?"
9393
9494
cannot be answered without cloning the entire repository and understanding how the languages
9595
used handle dependencies.
9696

97-
In particular when using C familiy languages, hidden dependencies on header files are easy to miss.
98-
For this reason limiting the visibility of files to the compiler by sandboxing is pretty much a requirement
97+
In particular, when using C family languages, hidden dependencies on header files are easy to miss.
98+
For this reason, limiting the visibility of files to the compiler by sandboxing is pretty much a requirement
9999
for reproducible builds.
100100

101-
With Josh, each deliverable gets it's own virtual git repository with dependencies declared in the `workspace.josh`
101+
With Josh, each deliverable gets its own virtual git repository with dependencies declared in the `workspace.josh`
102102
file. This means answering the above question becomes as simple as comparing commit ids.
103-
Furthermore due to the tree filtering each build is guaranteed to be perfectly sandboxed
103+
Furthermore, due to the tree filtering, each build is guaranteed to be perfectly sandboxed
104104
and only sees those parts of the monorepo that have actually been mapped.
105105

106-
This also means the deliverables to be re-build can be determined without cloning any repos like
106+
This also means the deliverables to be re-built can be determined without cloning any repos like
107107
typically necessary with normal build tools.
108108

109109
### GraphQL API
110110

111111
It is often desireable to access content stored in git without requiring a clone of the repository.
112-
This is usefull for CI/CD systems or web frontends such as dashboards.
112+
This is useful for CI/CD systems or web frontends, such as dashboards.
113113

114114
Josh exposes a GraphQL API for that purpose. For example, it can be used to find all workspaces currently
115115
present in the tree:

0 commit comments

Comments
 (0)