Skip to content

Commit 8dc938b

Browse files
committed
update README to be more clear on module structures
1 parent f7271ae commit 8dc938b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ make docker compose
1515
## :file_folder: Project structure
1616

1717
Since v1, the project has grown into three independent modules.
18-
- `github.com/imulab/go-scim/pkg/v2` module evolved from most of the original building blocks. This module provides
19-
customizable, extensible and opinion free implementation of the SCIM specification.
20-
- `github.com/imulab/go-scim/mongo/v2` module evolved from the original mongo package. This module provides persistence
21-
capabilities to MongoDB.
22-
- `github.com/imulab/go-scim` module evolved from the original example server implementation. It is now a __opinionated__
23-
personal server implementation that depends on the above two modules.
24-
25-
Documentation for the [pkg](https://github.com/imulab/go-scim/tree/master/pkg/v2) and [mongo](https://github.com/imulab/go-scim/tree/master/mongo/v2) module can be viewed in their respective directories.
18+
- [pkg module](https://github.com/imulab/go-scim/tree/master/pkg/v2) evolved from most of the original building blocks.
19+
This module provides customizable, extensible and opinion free implementation of the SCIM specification.
20+
- [mongo module](https://github.com/imulab/go-scim/tree/master/mongo/v2) evolved from the original mongo package.
21+
This module provides persistence capabilities to MongoDB.
22+
- [server module](https://github.com/imulab/go-scim) evolved from the original example server implementation. It is now
23+
an __opinionated__ personal server implementation that depends on the above two modules.
24+
25+
Documentation for the individual modules can be viewed in their respective directories and godoc badge links.
2626

2727
## :no_entry_sign: End of v1
2828

0 commit comments

Comments
 (0)