Commit Graph

69 Commits

Author SHA1 Message Date
Meet Mangukiya c6393f86d7 Remove yarn/npm from docs
Closes https://github.com/mitmproxy/mitmproxy/issues/3716
2020-02-25 03:38:10 +05:30
Maximilian Hils 80973bd6ec remove unused hyperlink in README.rst 2019-11-23 18:03:59 +01:00
Maximilian Hils 6ad7b575bb simplify install instructions 2019-11-20 18:45:36 +01:00
Maximilian Hils 51cea9eee3
update badges 2019-11-19 21:36:20 +01:00
Maximilian Hils 3af4647804
squash remaining forum reference 2019-11-04 16:05:43 +01:00
Maximilian Hils 0a197af6a2
update badges 2019-11-04 16:03:04 +01:00
Thomas Kriechbaumer f6405abda2
Merge pull request #3329 from Kriechi/readme-slogan
update readme slogan
2019-09-28 16:45:00 +02:00
Maximilian Hils 6eb47a5fa5
simplify testing instructions 2019-04-02 16:29:14 +02:00
Rajat Gupta 9b7c2566d3
Update README.rst 2019-02-28 23:59:50 +05:30
Thomas Kriechbaumer f95784ba9d update readme slogan 2018-09-21 10:38:25 +02:00
Maximilian Hils bbfa960023
fix appveyor link in README 2018-05-29 13:29:19 +02:00
Maximilian Hils f910f361a0
update appveyor badge 2018-05-22 11:15:24 +02:00
Maximilian Hils c6cf502657
simplify README 2018-03-28 13:28:53 +02:00
Thomas Kriechbaumer 79fc4e8ad6
fix badges 2018-03-27 17:25:15 +02:00
Thomas Kriechbaumer 3ae9407a38
fix docs-related URLs 2018-03-27 17:23:01 +02:00
Arushit Mudgal c50362a637
updating README according to recent doc updates
Hi,
The installation instructions linked back to old docs website.
I have updated the same
2018-03-05 07:27:00 +05:30
Thomas Kriechbaumer 10b6f6270b update doc location 2018-02-25 19:25:43 +01:00
kira0204 8209b89d41 Merge branch 'master' of https://github.com/kira0204/mitmproxy into update-readme 2018-02-24 12:42:21 +05:30
kira0204 69dbd1da61 Better language 2018-02-24 12:17:22 +05:30
Aldo Cortesi 982508d30f All new documentation
This patch does a lot.

- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.

With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.

With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 18:07:58 +13:00
kira0204 d045f879ac Extensive testing 2018-02-19 22:56:52 +05:30
Maximilian Hils 6e7030fcfb
update stale URL in README 2018-01-15 18:53:57 +01:00
Bas Broek dc37f7fd00 Add syntax highlighting to Readme 2017-03-29 13:36:51 +02:00
Maximilian Hils e4cb96f84d consolidate readme shields 2017-02-11 11:54:59 +01:00
Maximilian Hils 4746ce939f README: py.test -> pytest 2017-01-30 16:46:22 +01:00
Maximilian Hils 3fe2f9578a always use 'venv' as virtualenv folder 2017-01-30 00:40:24 +01:00
Maximilian Hils f570c57006 add contributing section to README, remove autoenv 2017-01-30 00:33:24 +01:00
Maximilian Hils a384dea62b rework README dev sections 2017-01-29 23:06:50 +01:00
Sachin Kelkar 38fd88b3d1 Update instructions 2017-01-06 15:33:05 +05:30
Maximilian Hils 843b1e17c9 add mitmweb to README 2016-12-27 20:47:47 +01:00
Aldo Cortesi c59b34bbb7 README.rst: recommend "tox -e lint" over using flake8 directly 2016-11-03 20:51:22 +13:00
Maximilian Hils 84555a601f fix README syntax 2016-10-22 17:20:45 -07:00
Aldo Cortesi 8430f857b5 The final piece: netlib -> mitproxy.net 2016-10-20 11:56:38 +13:00
Aldo Cortesi 381ad898ac Remove mention of pathod.net from README
I'm just about to redirect this to mitmproxy.org
2016-10-18 09:06:32 +13:00
Aldo Cortesi 43a83c89e7 python3: update README and setup.py trove classifiers 2016-10-17 18:42:48 +13:00
Aldo Cortesi 8360f70024 First-order conversion to Python3-only
- Zap various occurrences of Python2 in docs and scripts
- Remove six from netlib, and some other places where obvious project-wide
search and replace works.
2016-10-17 15:18:47 +13:00
Thomas Kriechbaumer 329909c514 update README about Python support 2016-07-19 10:43:57 +02:00
Maximilian Hils 636cbfd163 Update README.rst 2016-07-09 01:33:56 -07:00
Maximilian Hils a4fde737b1 fix appveyor 2016-06-28 21:18:01 -07:00
Thomas Kriechbaumer 566736c799 update appveyor with tox 2016-06-27 23:14:32 +02:00
Aldo Cortesi 4576dbf8aa Minor wording improvements for the README 2016-06-21 20:52:27 +12:00
Thomas Kriechbaumer 56af469b5a add Discourse to README 2016-06-21 10:03:32 +02:00
Thomas Kriechbaumer daa31c0fe0 hide codecov.yml 2016-06-16 18:13:03 +02:00
Thomas Kriechbaumer 1575fd3c9e update README with tox and flake8 info 2016-06-16 10:12:22 +02:00
Maximilian Hils e7ba89a327 Update README.rst 2016-06-07 00:32:29 -07:00
Aldo Cortesi 7191906ba8 Merge pull request #1192 from cortesi/testsuite
WIP: Solidify pathod test suite
2016-06-03 14:08:48 +12:00
Maximilian Hils 734ec94554 slightly improve readme wording 2016-06-02 18:25:56 -07:00
Aldo Cortesi c6d15904f3 Merge remote-tracking branch 'upstream/master' into testsuite 2016-06-03 10:19:22 +12:00
Sachin Kelkar 2ca066b7d6 Update README 2016-06-02 23:27:26 +05:30
Aldo Cortesi 14d6e1d2e3 Formatting of README
This is really a pretext to get Travis to rebuild, because it's stuck on the
wrong commit for the branch.
2016-06-02 16:43:46 +12:00