diff --git a/README.md b/README.md index 40b2e22d2535503a7dccf1d64dad27f251cf447d..576e198b635375516c0f5e6bec55946ec1ea4fb3 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ Would it be nice to not have to rely on a web service somewhere to deal with bugs ? -Would it be nice to be able to browse and edit bug report offline ? +Would it be nice to be able to browse and edit bug reports offline? -`git-bug` is a distributed bug tracker embedded in `git`. It use git's internal storage so **no files are added in your project**. +`git-bug` is a distributed bug tracker embedded in `git`. It uses git's internal storage so **no files are added in your project**. -As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples. +As you would do with commits and branches, you can push your bugs to the same git remote you are already using to collaborate with other people. :construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction: diff --git a/doc/model.md b/doc/model.md index 6f171c5ba507e25d731b7857b9141a269dd74a8f..11f18b18eab85e1ce9253ea7090ae02cb46c8461 100644 --- a/doc/model.md +++ b/doc/model.md @@ -1,6 +1,6 @@ # Data model -The biggest problem when creating a distributed bug tracker is that there is no central authoritative server (doh!). This imply some constraint. +The biggest problem when creating a distributed bug tracker is that there is no central authoritative server (doh!). This implies some constraints. ## Anybody can create and edit bugs at the same time as you @@ -97,4 +97,4 @@ Example of Tree of a later commit of a bug: 100644 blob 68383346c1a9503f28eec888efd300e9fc179ca0 ops 100644 blob a020a85baa788e12699a4d83dd735578f0d78c75 root ``` -Note that the `"root"` entry still reference the same root OperationPack. Also, all the clocks reference the same empty `Blob`. \ No newline at end of file +Note that the `"root"` entry still reference the same root OperationPack. Also, all the clocks reference the same empty `Blob`.