Skip to content

Commit 9cfdfd5

Browse files
committed
refactoring readme docs
1 parent bf19a07 commit 9cfdfd5

2 files changed

Lines changed: 32 additions & 19 deletions

File tree

README.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
image:https://travis-ci.com/devxchangeio/logmetrics-python.svg?branch=master["Build Status", link="https://travis-ci.com/devxchangeio/logmetrics-python"]
1+
image:://img.shields.io/pypi/v/logmetrics_sdk.svg[link="https://pypi.python.org/pypi/logmetrics_sdk"]
2+
image:://travis-ci.com/devxchangeio/logmetrics-python.svg?branch=master[link="https://travis-ci.com/devxchangeio/logmetrics-python"]
3+
image:://readthedocs.org/projects/logmetrics-python/badge/?version=latest[link="https://logmetrics.readthedocs.io/en/latest/?badge=latest"]
24

35
## logmetrics-python
46

@@ -16,7 +18,7 @@ LogMetrics framework provides simplified configuration to log payload for python
1618
"type": "string",
1719
"description": "Application Host IP Address"
1820
},
19-
"message_type": {
21+
"MessageType": {
2022
"type": "string",
2123
"description": "Logmetrics message type",
2224
"value": "LOGMETRICS_MESSAGE"
@@ -67,7 +69,7 @@ LogMetrics framework provides simplified configuration to log payload for python
6769
```
6870
{
6971
"Node": "127.0.0.1",
70-
"message_type": "LOGMETRICS_MESSAGE",
72+
"MessageType": "LOGMETRICS_MESSAGE",
7173
"Duration": 106,
7274
"Host": "hostname",
7375
"Fault": false,
@@ -80,20 +82,20 @@ LogMetrics framework provides simplified configuration to log payload for python
8082
}
8183
```
8284

83-
### Demo Project
85+
### Demo Project
8486

85-
https://github.com/devxchange-blog/logmetrics-demo.git[logmetrics-demo]
87+
https://github.com/devxchange-blog/logmetrics-python-demo.git[logmetrics-python-demo]
8688

8789
## Release History
8890

89-
** 0.0.1
91+
** 1.0.3
9092
* logging rest verb & payload to console.
9193
* feature to enable/disable payload logging
9294

9395
## Meta
9496
Karthikeyan Sadayamuthu – https://www.linkedin.com/in/ksadayamuthu/[LinkedIn]
9597

96-
Distributed under the Apache License. See ``LICENSE`` for more information. https://github.com/devxchange/logmetrics-java/blob/master/LICENSE[license]
98+
Distributed under the Apache License. See ``LICENSE`` for more information. https://github.com/devxchange/logmetrics-python-demo/blob/master/LICENSE[license]
9799

98100
## Contributing
99101

README.rst

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
=================
2-
logmetrics-python
2+
logmetrics-sdk
33
=================
44

5-
65
.. image:: https://img.shields.io/pypi/v/logmetrics_sdk.svg
76
:target: https://pypi.python.org/pypi/logmetrics_sdk
8-
9-
.. image:: https://img.shields.io/travis/ksadayamuthu/logmetrics_sdk.svg
7+
.. image:: https://img.shields.io/travis/devxchangeio/logmetrics-python.svg
108
:target: https://travis-ci.org/devxchangeio/logmetrics-python
11-
12-
.. image:: https://readthedocs.org/projects/logmetrics/badge/?version=latest
9+
.. image:: https://readthedocs.org/projects/logmetrics-python/badge/?version=latest
1310
:target: https://logmetrics.readthedocs.io/en/latest/?badge=latest
1411
:alt: Documentation Status
1512

16-
Python Boilerplate contains all the boilerplate you need to create a Python package.
13+
LogMetrics framework provides simplified configuration to log payload for python project.
1714

15+
**Usage - Python Flask Projects**
1816

19-
* Free software: Apache Software License 2.0
20-
* Documentation: https://logmetrics_sdk.readthedocs.io.
2117

18+
**Demo Project** -
19+
`logmetrics-python-demo <https://github.com/devxchange-blog/logmetrics-python-demo>`_
20+
21+
**Release History**
2222

23-
Features
24-
--------
23+
**1.0.3**
24+
* logging rest verb & payload to console.
25+
* feature to enable/disable payload logging
26+
27+
**Contributing**
28+
29+
1. Fork it!
30+
2. Create your feature branch: `git checkout -b my-new-feature`
31+
3. Commit your changes: `git commit -am 'Add some feature'`
32+
4. Push to the branch: `git push origin my-new-feature`
33+
5. Submit a pull request :D
34+
35+
* Free software: Apache Software License 2.0
36+
* Documentation: `logmetrics-sdk <https://logmetrics-python.readthedocs.io>`_
2537

26-
* TODO

0 commit comments

Comments
 (0)