Skip to content

Commit 6a05d74

Browse files
committed
update doc and ver to 1.0.0
1 parent 0309ebb commit 6a05d74

File tree

11 files changed

+19
-20
lines changed

11 files changed

+19
-20
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.15.0)
2-
project(7bitInjector VERSION 0.1.0)
2+
project(7bitInjector VERSION 1.0.0)
33

44
set(CMAKE_CXX_STANDARD 17)
55
set(CMAKE_CXX_STANDARD_REQUIRED ON)

Docs/advanced-guides/building-library.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Build Library
33

44
The library can be built locally using Cmake_ (`Cmake Installation`_)
55

6-
Create build directory and navigate to it:
6+
Create a build directory and navigate to it:
77

88
.. code-block:: sh
99
1010
mkdir build && cd build
1111
12-
Configure cmake project
12+
Configure CMake project
1313

1414
.. code-block:: sh
1515
@@ -24,7 +24,7 @@ Using this command several cache variables can be set:
2424
* BUILD_EXAMPLES: [true, false] (false) - Turn on to build examples
2525

2626
to set cache variable pass additional option: -D<variable cache name>=[value]
27-
for example this command will set library type to Static and will force examples built
27+
for example, this command will set the library type to Static and will force examples built
2828

2929
.. code-block:: sh
3030
@@ -41,7 +41,7 @@ Build Library With Conan
4141
^^^^^^^^^^^^^^^
4242

4343
Gtest_ library is added to project using Conan_ package manager (`Conan Installation`_),
44-
If conan was fresh installed run detect command:
44+
If Conan was freshly installed run detect command:
4545

4646
.. code-block:: sh
4747
@@ -53,13 +53,13 @@ To install Conan packages run this command in the library root folder:
5353
5454
conan install . --output-folder=build --build=missing
5555
56-
Navigate to build directory:
56+
Navigate to the build directory:
5757

5858
.. code-block:: sh
5959
6060
cd build
6161
62-
Configure cmake project, add also toolchain file as a CMAKE_TOOLCHAIN_FILE cache variable:
62+
Configure the CMake project, and add also toolchain file as a CMAKE_TOOLCHAIN_FILE cache variable:
6363

6464
.. code-block:: sh
6565

Docs/basic-guides/injecting-multiple-services.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Multiple services can inherit one interface and can be injected using a vector.
99

1010
Injection rules are simple:
1111

12-
* It is guaranteed that vectors won't contain null pointners
12+
* It is guaranteed that vectors won't contain null pointers
1313
* Singleton/scoped services should be injected using std::vector<pointners>
1414
* Transient services should be injected using std::vector<std::unique_ptr>
1515

Docs/basic-guides/injecting-services.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This example shows the main purpose of this library, injecting services into ser
88

99
* Service should have one constructor
1010
* It is guaranteed that injected service won`t be null
11-
* Singleton/scoped service should be injected using pointners (references are not allowed due to library limitations, it might be fixed in the future)
11+
* Singleton/scoped service should be injected using pointers (references are not allowed due to library limitations, it might be fixed in the future)
1212
* Transient services should be injected using std::unique_ptr
1313

1414
.. literalinclude:: ../../Examples/Guides/InjectingServices.cpp

Docs/basic-guides/injection-rules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Injecting Services
1919
* Pointers: (T*)
2020
* Const pointner: (T* const)
2121
* Pointner to const object: (const T*)
22-
* Const pointner to const object: (const T* const)
22+
* Const pointer to const object: (const T* const)
2323
* Transient services can be injected using std::unique_ptr: (unique_ptr<T>)
2424
* Multiple services implementing specified interface can be injected using std::vector:
2525

Docs/basic-guides/services-lifetime.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Service providers can create scoped service providers:
99
1010
IServiceProvider::Ptr scoped = provider->createScope()
1111
12-
Service can be registered as singleton, scoped or transient.
12+
Service can be registered as a singleton, scoped, or transient.
1313

1414
* Singleton: service provider will create only one instance of this service (accessible via the getService method)
1515
* Scoped: service provider will create only one instance of this service for each scope (accessible via the getService method)

Docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def createIfNotExists(path):
1313
project = "7bitInjector"
1414
copyright = "2023, 7BitCoder Sylwester Dawida"
1515
author = "Sylwester Dawida"
16-
version = "0.1.0"
16+
version = "1.0.0"
1717

1818
extensions = [
1919
"sphinx.ext.autodoc",

Docs/getting-started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Supported Platforms
66

77
7bitInjector requires client code and compiler compatible with the C++17 standard or newer.
88

9-
Library is officially supported on the following platforms:
9+
The library is officially supported on the following platforms:
1010

1111
**Operating systems:**
1212

Docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Navigation
2020
.. toctree::
2121
:titlesonly:
2222
:maxdepth: 1
23-
:glob:
2423

2524
getting-started
2625
basic-guides

Include/SevenBit/DI/CmakeDef.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
/* #undef SEVEN_BIT_INJECTOR_STATIC_LIB */
55
#define SEVEN_BIT_INJECTOR_HEADER_ONLY_LIB
66

7-
#define SEVEN_BIT_INJECTOR_VERSION "0.1.0"
7+
#define SEVEN_BIT_INJECTOR_VERSION "1.0.0"

0 commit comments

Comments
 (0)