Merge pull request #2 from Dup4/feat-readme

feat: readme

.vscode/settings.json

@@ -6,7 +6,7 @@
     "files.insertFinalNewline": true,
     "files.trimFinalNewlines": true,
     "clangd.arguments": [
-        "--compile-commands-dir=./",
+        "--compile-commands-dir=./build",
         "--background-index",
         "--header-insertion=never",
         "--all-scopes-completion",

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Dup4
+Copyright (c) 2022 - PRESENT Dup4
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,3 +6,36 @@
 [![Test](https://github.com/Dup4/autowired-cpp/workflows/Test/badge.svg)](https://github.com/Dup4/autowired-cpp/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/Dup4/autowired-cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/Dup4/autowired-cpp)
 [![GitHub release](https://img.shields.io/github/release/Dup4/autowired-cpp.svg)](https://GitHub.com/Dup4/autowired-cpp/releases/)
+
+## Integration
+
+### CMake
+
+```cmake
+FetchContent_Declare(
+    autowired
+    QUIET
+    GIT_REPOSITORY https://github.com/Dup4/autowired-cpp.git
+    GIT_TAG v{x.y.z} # Where `x.y.z` is the release version you want to use.
+)
+```
+
+### Bazel
+
+```bazel
+git_repository(
+    name = "autowired",
+    remote = "https://github.com/Dup4/autowired-cpp.git",
+    tag = "v{x.y.z}",  # Where `x.y.z` is the release version you want to use.
+)
+```
+
+## Usage
+
+See the usage in the [unit test](./test/autowired_v1_test.cc)
+
+## License
+
+[MIT](./LICENSE) License © 2022 - PRESENT [Dup4][dup4]
+
+[dup4]: https://github.com/Dup4